docs-writer

Write, review, and audit Markdown documentation following Gemini CLI style standards.

Updated Aug 26, 2026
One-click install
npx skills add https://github.com/rameshkumarchouhanr/gemni-cli --skill docs-writer-rameshkumarchouhanr
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/rameshkumarchouhanr/gemni-cli/tree/main/.gemini/skills/docs-writer
Command: npx skills add https://github.com/rameshkumarchouhanr/gemni-cli --skill docs-writer-rameshkumarchouhanr

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Maintaining consistent, accurate technical documentation across a large repository is difficult. This Skill enforces the Gemini CLI documentation style guide when writing, editing, or auditing Markdown files, ensuring tone, formatting, links, and terminology stay consistent with the codebase. ## Core Features & Use Cases - Style enforcement: Applies rules for voice, grammar, formatting, links, and structure (BLUF, headings, callouts, 80-character wrap) to every documentation change. - Documentation auditing: Runs a multi-phase audit workflow (editor, software engineer, technical writer) that checks the docset against the style guide and verifies code accuracy in packages/. - Terminology guidance: Distinguishes "quota" vs. "limit" usage and other project-specific terminology via the included style guide. - Use Case: When asked to update a page in /docs, the Skill investigates the relevant source code, edits the Markdown per the style rules, checks deep links to changed headings, and finishes with npm run format. ## Quick Start Ask the agent to review and update the getting-started guide in the docs directory so it follows the project documentation standards.

Frequently Asked Questions about docs-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write documentation that follows the Gemini CLI style guide?

Activate the docs-writer skill whenever writing or editing files in /docs or any Markdown file. It enforces rules for voice, tense, formatting, links, and structure, and verifies content against the actual codebase in packages/.

How do I audit an entire documentation set for style violations?

Follow the procedural guide in references/docs-auditing.md. It defines three phases: an editor audit for style violations, a software engineer audit for undocumented features, and a technical writer phase that implements approved fixes.

When should I use "quota" versus "limit" in documentation?

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 provides detailed examples.

Does the docs-writer skill verify documentation against source code?

Yes. Before editing, 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 in the docs.

What formatting checks run after documentation changes?

After all edits, the skill runs npm run format to ensure consistent project formatting, running npm install first if dependencies are missing. It also verifies links and updates deep links when headings change.