Write, review, and audit Markdown documentation following project style standards.
npx skills add https://github.com/bkrsna/gemini-cli --skill docs-writer-bkrsna
Please help me install this Agent Skill. Skill: docs-writer Source: https://github.com/bkrsna/gemini-cli/tree/main/.gemini/skills/docs-writer Command: npx skills add https://github.com/bkrsna/gemini-cli --skill docs-writer-bkrsna
/docs directory, ensuring content matches the current codebase. ## Core Features & Use Cases - Style enforcement: Applies rules for voice, tone, grammar, formatting, links, and document structure (BLUF, headings, procedures, callouts) to every documentation change. - Documentation auditing: Runs a three-phase audit workflow (Editor, Software Engineer, Technical Writer) that finds style violations, verifies code accuracy against packages/, and identifies undocumented features. - Terminology consistency: Uses the quota-vs-limit style guide to keep resource-capacity wording consistent across user-facing content. - Use Case: When asked to document a new CLI command, the Skill inspects the relevant code in packages/, drafts the page following all style rules, checks links and docs/sidebar.json, and finishes with npm run format. ## Quick Start Ask the assistant to write or review a documentation page in the docs directory following the project style guide.High-intent search queries and answers about installing and using this skill.
Invoke the docs-writer skill whenever writing or editing files in /docs or any Markdown file. It applies rules for voice, tense, formatting, links, and structure, then verifies accuracy against the codebase in packages/.
Follow the procedural guide in references/docs-auditing.md. It runs an Editor phase for style violations, a Software Engineer phase for undocumented features, and a Technical Writer phase that implements approved fixes.
Use quota for the administrative bucket covering settings, billing, and increase requests. Use limit for the numerical ceiling in error messages and real-time feedback. The quota-limit-style-guide.md file defines the full terminology rules.
Yes. Before modifying documentation, the skill investigates relevant code in the packages/ directory to confirm accuracy. During audits it uses grep_search and read_file to validate code snippets, commands, and version numbers.
After all edits, the skill asks to run npm run format for consistent project formatting. It also verifies links, checks deep links when headings change, and runs docs generation scripts like npm run docs:settings when needed.
tsmesWrite accurate, minimal documentation for code, features, and systems.
channgGenerate static documentation websites from markdown files with sidebar navigation.
adriannoesAnalyze and validate technical diagrams for standards compliance.
10knamesmoreAdd or complete documentation comments to Rust and TypeScript code.