Writing Docs
Businesswriting-docsWriting 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.
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/ngrx/platform/blob/HEAD/.agents/skills/writing-docs/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/writing-docs, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
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.