docs-writer

Write and edit Markdown documentation following Gemini CLI project standards.

1|Updated Mar 26, 2026
One-click install
npx skills add https://github.com/caobingsheng/skills --skill docs-writer-caobingsheng
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/caobingsheng/skills/tree/main/.claude/skills/docs-writer
Command: npx skills add https://github.com/caobingsheng/skills --skill docs-writer-caobingsheng

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The skill ensures clear, accurate, and consistent documentation for the Gemini CLI project, enforcing project-wide standards when writing, editing, or reviewing Markdown in the /docs directory or any repository md files.

Core Features & Use Cases

  • Enforces the project documentation standards, including voice, tone, grammar, and formatting per CONTRIBUTING.md and quota-style-guide guidelines.
  • Assists in writing, reviewing, and editing documentation to reflect current code and behavior, ensuring alignment with the Gemini CLI project.
  • Uses a structured workflow for preparing, editing, and finalizing docs, including audits against the current codebase and cross-referencing related docs.

Quick Start

Provide a standards-compliant draft for the requested documentation topic and have it reviewed against the project's writing guidelines.

Frequently Asked Questions about docs-writer

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

FAQPage Schema
How do I enforce documentation consistency and tone across Markdown files?

To enforce documentation consistency, apply a structured workflow that reviews Markdown files against a style guide, ensuring uniform tone, grammar, and formatting across all project docs.

What is the best way to review repository documentation for alignment with current code?

Reviewing repository documentation requires auditing Markdown files against the current codebase to verify accuracy, cross-referencing related docs to ensure all text reflects existing project behavior.

How do I write standards-compliant Markdown documentation with correct frontmatter?

Write standards-compliant Markdown by drafting content that adheres to project formatting guidelines, applying required frontmatter structure, and validating voice and tone rules before finalizing.

Does this documentation writing approach work for files outside the /docs directory?

Yes, this approach works for any Markdown files throughout the project, applying the same voice, tone, and grammar standards used for the /docs directory to ensure project-wide consistency.

When should I use an automated style guide check for project documentation?

Use an automated style guide check when writing, editing, or reviewing repository documentation to enforce project-wide standards, ensuring clear, accurate, and consistent Markdown across all files.