thegooddocsproject / templates

Templates created by The Good Docs Project - for all your tech writing needs.
https://thegooddocsproject.dev/
Other
676 stars 170 forks source link

Create FAQ template or guide #231

Open barbaricyawps opened 2 years ago

barbaricyawps commented 2 years ago

I hope this isn't a duplicate ticket, but there was an interesting discussion about FAQ writing on the Write the Docs channel that I wanted to capture and evaluate whether it would make a good template or guide.

Q: What is the best use of FAQs you’ve seen? Looking for examples for low-tech people using consumer tech. Any advice on structuring useful questions?

One answer: I've generally only seen examples of FAQs that make me agree with these articles that they should be avoided: https://kayce.basqu.es/blog/FAQs https://gds.blog.gov.uk/2013/07/25/faqs-why-we-dont-have-them/ But if there are good examples, I'd be happy to change my mind, since (as the second article suggests) they are easier to write.

Another answer: I do think the Google Workspace Updates blog is a good example of an FAQ-like format done well. Each update has "what's changing, who's affected, why it's important" - e.g. https://workspaceupdates.googleblog.com/2021/10/enhanced-menus-in-google-sheets.html

Another answer: This is my fave, but it's mostly not tech related: https://edgefieldconcerts.com/plan-your-visit/faqs/