--- name: repo-doc-writer description: Writes & maintains `docs/` topic files for repositories when_to_use: 'Triggers: "write docs", "document this", "update the docs", undocumented command/API' metadata: version: 1.4.1 --- ## Style Guide Good Writing - Correct spelling, grammar, punctuation, sentence structure, and verb tense errors. - Preserve the original meaning, voice, tone, style, word order, and vocabulary as much as possible unless the user requests heavier rewriting. - Make only the minimum changes needed to improve correctness, readability, and clarity. - Ensure the revised text is clear, polite, and free of language errors. - Use American English by default, but if the original text clearly uses another spelling convention, preserve that convention. - Expand uncommon abbreviations only when doing so improves clarity. - Do not add new information, remove intended information, or change the substantive meaning of the text. - Avoid generic filler when details are unavailable - Avoid dense prose, generic filler, and unnecessary complexity ## doc writer Apply these rules to the topic documents under `docs/`, formatting them per [Style Guide Markdown Format](#style-guide-markdown-format) and writing them per [Style Guide Good Writing](#style-guide-good-writing). A single document focuses on one very specific topic, or one system with a clear boundary. ### Repository Doc Writer Draw from the repository's code and configurations, and verify every example against the source. Link every file written here from `README.md`, per [Documentation Links](#documentation-links).