A handbook
Documentation that lives where it is written and reviewed.
A team's handbook is written in documents anyway: how we work, how to set things up, who to ask. Publishing it usually means copying it somewhere else, where it goes stale. With Foldocs the documents are the handbook, and the site is how you read it.
The folder
- 📁 Handbook
- 📁 profile
- 📄 home
- 📄 Contact
- 📁 1 Getting started
- 📄 01 Your first day
- 📄 02 Accounts and tools
- 📄 03 Who's who
- 📁 2 How we work
- 📄 01 Meetings
- 📄 02 Writing things down
- 📁 Releases
- 📄 01 Checklist
- 📁 3 Reference
- 📁 Glossary
- 📁 Templates
- 📁 profile
On the site
Numbered chapters in numbered folders keep their order everywhere. Headings in a document become anchors to link to, so see Releases, step 3 can be a link. Shown as a folder tree, the whole handbook reads like a table of contents, every page one click away.
Reviewing
Changes are suggested and discussed in the documents, with comments, before anyone accepts them. Comments and suggestions never reach the site; the accepted text does, five minutes after the last edit. See From folder to site.