search

humanmade / altis-documentation

Documentation module for Altis
https://docs.altis-dxp.com/
6 stars 3 forks source link

Add an FAQ to the Developer and User documentation sets #414

Open mikelittle opened 2 years ago

mikelittle commented 2 years ago

Each of the documentation sets -- Developer and User -- should have FAQs.

It will be worth waiting until there are at least four or five items for each before publishing.

However we could work on the content of them in this ticket or other linked tickets.

owaincuvelier commented 2 years ago

I'm been thinking a lot about the FAQs a lot, and one thing that's stopped me is how I've wanted the FAQ to be as accessible as possible to editors. I hate editing in GitHub and it's terrible for making fast on-the-fly edits to documentation, this is why I've not started an official FAQ to date.

As you noted, there is a minimum amount of FAQs before we can publish anything so similarly I've started, but not published an FAQ here: https://humanmade.zendesk.com/hc/en-us/categories/6967490172051-FAQ but I still hadn't decided how many FAQ articles before publishing was enough, and I admitidly wasn't too thrilled about using Zendesk Guides as the FAQ location, prefering all docs to be in a single location. That said, not having an FAQ helps no one, so its time to bite the bullet.

What is the page structure you had in mind for this? A single header FAQ with sub pages? Or all the FAQs on a single FAQ page?