athensresearch
Create FAQs Page
Why?
Provide a place where people can find quick answers to questions. Reduces workload for admins and other contributors to ClojureFam.
What and How?
Create a FAQs markdown file.
Feel free to look at a draft FAQs page that was started and never finished: Notion Doc - FAQs ClojureFam Very WIP
Look at other FAQ pages on Github. Can you find good examples?
Points to Ponder
- How can one question answer many other questions?
- Is there a good way to order, sort, or categorize the questions?
- How can you find out what good questions would be? (Hint: our Discord)
- How will you get answers for questions you don't have answers for?
Action Items:
- [ ] Look at FAQ page examples
- [ ] Decide on FAQ page design
- [ ] Make list of questions (and answers?)
Hi @nthd3gr33 - I considered this a little yesterday evening and was thinking we could do the following:
-
Set up a GitHub Wiki to act as a welcoming / informational area (in addition to the readme page) with information and answers to the likely most common questions - a bit like those in the notion board. We could maybe even have a brief step by step installation and running of Clojure.
-
A few example decent Wiki pages I have found are:
- https://github.com/snowplow/snowplow/wiki
- https://github.com/mcMMO-Dev/mcMMO/wiki
- https://github.com/Netflix/Hystrix/wiki (this is my fav. nice and clean and to the point)
- https://github.com/d3/d3/wiki
- For code specific questions we could direct people to the Discord board (maybe we could have a new channel called "Code Questions" or something similar where people can discuss Clojure specific questions.
What are the benefits of the above:
- Free
- Easy to set up and use and can then direct people to a specific link - if common questions are asked on Discord a bot can be set up to direct people here in the first instance
- Can be easily maintained.
Hope this helps
P.S. on Discord I am edns100 and more than happy to help out getting something set up if needed.
