search

athensresearch / ClojureFam

Clojure Learning Program
199 stars 15 forks source link

Create FAQs Page #10

Open nthd3gr33 opened 4 years ago

nthd3gr33 commented 4 years ago

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

  1. How can one question answer many other questions?
  2. Is there a good way to order, sort, or categorize the questions?
  3. How can you find out what good questions would be? (Hint: our Discord)
  4. How will you get answers for questions you don't have answers for?

Action Items:

ens100 commented 4 years ago

Hi @nthd3gr33 - I considered this a little yesterday evening and was thinking we could do the following:

  1. 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.

  2. A few example decent Wiki pages I have found are:

  1. 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:

  1. Free
  2. 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
  3. 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.