Skip to content

Commit

Permalink
more on technical writing
Browse files Browse the repository at this point in the history
  • Loading branch information
mustafah15 committed Aug 22, 2023
1 parent 6d2cdee commit 92b5c6f
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 3 deletions.
4 changes: 4 additions & 0 deletions pages/FAQ Research.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- start your research for the customer behavior, what they are asking about what are the biggest pain points.
- categorize your research
- look for common themes and start categorizing them accordingly.
- consider creating a separate FAQ article for each category to make it easier for customers to find information.
9 changes: 9 additions & 0 deletions pages/FAQs Structure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
- here is what is the structure of an FAQ article should look like
- title, Use the format [subject] FAQs.
- example return police FAQs
- intro
- briefly describe what the FAQs are about so they know they've found what there were looking for.
- question with answer
- pay attention to the words your customer use to describe your product or service. write your FAQs using the same words as they use instead of your company internal terminology
- related article
- this part is optional but recommended if you have one or more article that are related to the same topic. list them at the bottom of your FAQs article to make them easily accessible for your readers.
9 changes: 6 additions & 3 deletions pages/FAQs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
- it's an easy technical writing model so it's a great one to practice as a new technical writer.
- it has a simple two-part writing structure that you repeat as many times as needed, Question, Answer.
- different from step-by-step instruction FAQs are less goal-oriented they are not meant to focus the reader on completing a certain task and lead them to execute from start to finish, however, their purpose is to give readers quick answers to their most common questions
- know your audience and write questions in their voice.
- write short and to-the-point answers.
- steps for writing a good FAQs
- research customer behavior, what they are asking about what are the biggest pain points.
- know your audience and write questions in their voice.
- write short and to-the-point answers.
- [[FAQ Research]]
- [[FAQs Structure]]
-
-

0 comments on commit 92b5c6f

Please sign in to comment.