# Writing Docs

> Writing Docs is an Agent Skill for business published in the ngrx/platform repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Doc conventions (impersonal style, formatting, Vitest in examples, structure, linking). Use when writing, editing, or reviewing guides, tutorials, or READMEs.

- Skill name: `writing-docs`
- Category: [Business](https://www.openparable.com/skill/business/1)
- Source: https://github.com/ngrx/platform/blob/HEAD/.agents/skills/writing-docs/SKILL.md
- Repository: ngrx/platform (8,321 GitHub stars when collected)

## SKILL.md

# 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.

---

Source: https://www.openparable.com/skill/business/writing-docs (OpenParable). Cite the canonical URL above.
