organicmaps / organicmaps/website

Complete /faq/ section (Google Seasons of Docs)

Open
#211 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Google Season of Docs
Dominant language
Python
Stars
36
Forks
44
Avg merge
6h 50m
Merged PRs (30d)
4

Description

Problem

Many users have questions regarding the functionality, features, and usage of the Organic Maps mobile app. Without a comprehensive F.A.Q. section, users may encounter difficulties in understanding and utilizing the app effectively, leading to frustration and reduced user satisfaction.

Scope

The scope of this task involves creating an end-user F.A.Q. section that addresses common questions, concerns, and inquiries related to the Organic Maps mobile app. The F.A.Q. should cover various aspects of the app, including but not limited to installation, navigation, features, settings, troubleshooting, and support.

Success Criteria
  1. Comprehensive Coverage: The F.A.Q. should cover a wide range of topics and address common user queries comprehensively.
  2. Clarity and Conciseness: Each question and corresponding answer should be clear, concise, and easy to understand for users of all levels of technical proficiency.
  3. Accessibility: The F.A.Q. should be easily accessible within the app, preferably through a dedicated section in the app's menu or settings.
  4. Updated Information: Ensure that the F.A.Q. reflects the latest version of the Organic Maps app, including any recent updates or changes.
  5. User Feedback Integration: Consider incorporating feedback from user testing and previous user inquiries to address common pain points and improve the overall effectiveness of the F.A.Q.
Skills
  • Technical Writing: Ability to communicate complex technical concepts in a clear and understandable manner suitable for end-users.
  • User Experience (UX) Design: Understanding of user needs and preferences to create an intuitive and user-friendly F.A.Q. layout and navigation.
  • Knowledge of Organic Maps: Familiarity with the features, functionalities, and settings of the Organic Maps mobile app to accurately address user inquiries.
  • Communication: Ability to collaborate with stakeholders, including developers, designers, and product managers, to gather relevant information and ensure alignment with the app's objectives and user needs.
  • Quality Assurance: Thorough testing and validation of the F.A.Q. content to ensure accuracy, completeness, and effectiveness in addressing user queries.
See also

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing FAQ in data/faq.html and the linked website drafts in pull requests 185, 204, and 115. Compare them with the issue's requested coverage, accessibility, and update criteria. Done means a comprehensive, clear, current FAQ section is available to Organic Maps users and incorporates relevant feedback.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.