writing-docs
Doc conventions (impersonal style, formatting, Vitest in examples, structure, linking). Use when writing, editing, or reviewing guides, tutorials, or READMEs.
Source facts
- Repository
- ngrx/platform
- Last source activity
- March 6, 2026 at 14:54
- Detected SKILL.md language
- English
- Stars
- 8,338
- Forks
- 2,033
Install options
The review-first prompt is selected by default. You can switch to a direct command or download a local copy.
Review the source files
Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.
Showing SKILL.md
SKILL.md
Source instructions · Read-only preview- name
- writing-docs
- description
- Doc conventions (impersonal style, formatting, Vitest in examples, structure, linking). Use when writing, editing, or reviewing guides, tutorials, or READMEs.
# Writing Documentation
Apply when writing, editing, or reviewing docs.
## Voice and style
- **Impersonal:** No "you", "your", or second-person imperatives.
- **Statements over imperatives:** Prefer "Tests should not spy" over "Avoid spying"; passive or descriptive phrasing.
- **Titles:** Gerunds, not imperatives (e.g. "Testing the store" not "Test the store").
- **Tone:** Direct and minimal; every sentence adds information.
## Formatting
- **Dashes:** Space-hyphen-space (`-`), not em dash (`—`).
- **Paragraphs:** Merge single-sentence paragraphs when it helps readability.
## Code examples
- **Examples:** Simple, self-contained (e.g. Counter, Books). Short snippets; shorten or link out long async flows unless the topic is async.
## Structure and navigation
- **Section titles:** Accurate and scannable.
- **Links over repetition:** Link to other guides; explain only what is specific to this page.
View on GitHub