writing-docs
Doc conventions (impersonal style, formatting, Vitest in examples, structure, linking). Use when writing, editing, or reviewing guides, tutorials, or READMEs.
ソース情報
- リポジトリ
- ngrx/platform
- ソースの最終更新活動
- 2026年3月6日 14:54
- 検出された SKILL.md の言語
- 英語
- スター
- 8,343
- フォーク
- 2,032
インストール方法
デフォルトでは、最初にソースを確認する Prompt が選択されています。直接コマンドに切り替えるか、ローカルコピーをダウンロードすることもできます。
ソースファイルを確認
インストールを決める前に、SKILL.md と SkillsMP に表示されている付属ファイルをお読みください。
SKILL.md を表示中
SKILL.md
ソースの指示 · 読み取り専用プレビュー- 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.
GitHubで見る