docs-writer

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

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Maintaining consistent, accurate technical documentation across a large project is difficult. This Skill enforces the Gemini CLI documentation style guide when writing, editing, reviewing, or auditing Markdown files in the /docs directory, ensuring content matches the current codebase. ## Core Features & Use Cases - Style Enforcement: Applies voice, tone, grammar, formatting, link, and structure rules (80-character wrap, sentence case, BLUF, 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 investigates the implementation in packages/, writes the page following all standards, checks cross-references and docs/sidebar.json, and finishes with npm run format. ## Quick Start Use the docs-writer skill to write a new documentation page for the recently added CLI command and verify it against the style guide.

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, tone, grammar, 80-character text wrapping, sentence-case headings, relative links, and structural patterns like BLUF and Next steps sections.

How do I audit a documentation set for style and accuracy issues?

Follow the docs-auditing.md reference, which defines a three-phase process: an Editor phase that flags style violations per page, a Software Engineer phase that finds undocumented features in the codebase, 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, and limit for the numerical ceiling in errors and warnings. When a user is blocked, combine both: state the limit that was hit and the quota that is the remedy.

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

Yes. Before modifying docs, the Skill investigates relevant code in the packages/ directory to confirm accuracy, and during audits it uses grep_search and read_file to validate code snippets, commands, and version numbers in documentation.

What formatting checks run after editing documentation?

After all changes, the Skill asks to run npm run format to ensure consistent project formatting, running npm install first if dependencies are missing. It also verifies links, including deep links to any changed headings.