Authoring: writing and editing chapters
Before you write
- Read the style rules and
spec/conventions.mdat the repository root. - Check
spec/structure.mdat the repository root to see where the topic fits and what number it should have.
Writing a new chapter
- Pick the part and the next free decimal number in that part. Numbering is contiguous, so a new chapter usually takes the next number after the last one in its part.
- Create
locales/en-us/topics/PP-CC-slug/index.md(zero-padded, dash-separated prefix, for example08-01-...) from the chapter template. Add aREADME.mdsymlink toindex.mdand a.locale-peer-id(32 lowercase hex characters). - Write to the template. Every content chapter needs all of its sections: overview, key principles, recommendations, trade-offs (with a table), examples (one enterprise and one government), business case, anti-patterns, a five-level maturity model, discussion ideas, key takeaways, and references.
- Define terms on first use. Add Wikipedia links to key concepts on first mention, in prose only.
- Cross-reference related chapters by decimal, for example “(chapter 8.1).”
- Add the chapter to
spec/structure.md. - If the part introduction (N.0) lists its chapters, add a bullet there.
- Run
just nav, thenjust test.
Editing an existing chapter
- Keep the section order and headings intact. The tests check that content chapters still have every required section.
- Preserve inline definitions, Wikipedia links, tables, and the references list unless the edit is specifically about them.
- Do not introduce em-dashes or the forbidden phrases. If you are rephrasing, reword rather than dropping in a dash.
Renaming or renumbering
- Rename the file, update its
# N.M Titleheading, updatespec/structure.md, and update every cross-reference that points to the old number. - Run
just navandjust test. The tests will flag a mismatch between the H1 and the file name, a numbering gap, or a broken link.
Tone reminder
Write like an experienced colleague who wants the reader to succeed. Warm, plain, direct, and useful. Short sentences. No filler.