Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Create FAQ template or guide #231

Open
barbaricyawps opened this issue Nov 2, 2021 · 0 comments
Open

Create FAQ template or guide #231

barbaricyawps opened this issue Nov 2, 2021 · 0 comments
Labels
templates Denotes only issues about creating our doc type templates. templates-p3

Comments

@barbaricyawps
Copy link
Contributor

barbaricyawps commented Nov 2, 2021

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/

@barbaricyawps barbaricyawps added the templates Denotes only issues about creating our doc type templates. label Nov 2, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
templates Denotes only issues about creating our doc type templates. templates-p3
Projects
None yet
Development

No branches or pull requests

2 participants