Replace this callout with two or three sentences describing what docs does, written for a reader who has never heard of it. Name the job it does rather than the category it sits in — "keeps stock counts in sync across warehouses" tells a reader more than "an operations platform".
Where to start#
| If you are… | Go to |
|---|---|
| New, and want it working today | Getting started |
| Comparing docs with something else | What docs can do |
| Rolling it out to colleagues | Invite your team |
| Stuck on one specific question | FAQ |
How this site is organised#
Each section makes a different promise, and mixing them is what makes documentation hard to read.
- Getting started is the shortest path from nothing to a working setup. It assumes no prior knowledge and explains nothing it does not have to.
- Features describes capabilities, so an evaluator can decide whether docs covers their case before signing up.
- Guides are task-shaped. Each one has a goal in the title and ends with a result the reader can check.
- FAQ collects the questions that arrive more than twice.
Two habits that keep this site true#
- Change the page in the same pull request that changes the product. A stale instruction costs more support time than a missing one.
- When a customer asks the same question twice, write the answer down once instead of answering it a third time.
Link to https://docsbook.io/Docsbook-websites/docs-6 from the product's help menu so nobody has to go looking for these pages.
Next steps#
- Getting started — from sign-up to a working setup.
- What docs can do — the full picture in one table.
- Invite your team — bring colleagues in safely.
- FAQ — short answers to recurring questions.