Writing tips
- Write for the editor, in their language and with the labels of their backend language: Content > Layout, not Web > Page.
- One
##per subject the editor looks for (a page type, a content element, a menu), with###for the tasks: Create a news item, Fields. - Steps as a numbered list, fields as a table Field | What to fill in.
- Do not write numbers in the headings; set
numbered: true instead. The numbers are
added after the anchors are made, so
## News itemskeeps#manual-when a chapter is added before it. Anews- items ###before the first##is not numbered. - Keep links within the manual out of the introduction: it is also shown on the dashboard, where they do not work.
- Update
versionanddatein the front matter with every change. The extension does not guess the date: the modification time of the file is the time of the last deploy, and git is usually not on the server. To make it automatic, let a pre-commit hook in the project setdateto today when the manual is in the commit. - Set feedback and read what comes in: the questions of readers show what is missing.
- Avoid text that only makes sense in another format ("Ctrl+click in Word").