docs-writer

Write and refine Gemini CLI Markdown documentation to conform with CONTRIBUTING.md standards.

106k|14.4k|Updated Apr 17, 2025
One-click install
npx skills add https://github.com/google-gemini/gemini-cli --skill docs-writer-google-gemini
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/google-gemini/gemini-cli/tree/main/.gemini/skills/docs-writer
Command: npx skills add https://github.com/google-gemini/gemini-cli --skill docs-writer-google-gemini

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation is often inconsistent and hard to maintain across the Gemini CLI project. This skill provides a clear, repeatable approach for writing, editing, and reviewing Markdown content to ensure accuracy, clarity, and conformance with project standards.

Core Features & Use Cases

  • Enforces Gemini CLI documentation standards and voice guidelines across Markdown files.
  • Provides a structured approach for drafting, reviewing, and refining content to ensure conformance with CONTRIBUTING.md.
  • Supports quick revisions and consistency checks for existing docs, ensuring updates stay in sync with code changes.

Quick Start

Ask the docs-writer skill to draft or revise a Gemini CLI Markdown document located under the /docs directory or any .md file in the repo. Provide the target file path and any style guidelines (e.g., refer to CONTRIBUTING.md) and specify the desired tone and audience. Review the generated content for alignment with project standards and iterate as needed.

Frequently Asked Questions about docs-writer

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

FAQPage Schema
How do I write and edit Markdown documentation for the Gemini CLI?

To write and edit Markdown documentation for the Gemini CLI, you can use the docs-writer skill to draft, review, and refine .md files. It enforces formatting, tone, and structure rules while ensuring consistency with CONTRIBUTING.md and project standards.

How do I ensure my Markdown docs match project contributing standards?

To ensure your Markdown docs match project contributing standards, the docs-writer skill checks your content against CONTRIBUTING.md. It provides a structured approach for reviewing and refining content to ensure accuracy, clarity, and conformance with project guidelines.

Can I update existing Markdown files in the /docs directory?

Yes, you can update existing Markdown files in the /docs directory. The docs-writer skill supports quick revisions and consistency checks for existing docs, ensuring your updates stay in sync with code changes and project standards.

What is the best way to maintain consistency across Markdown documentation?

The best way to maintain consistency across Markdown documentation is to apply a clear, repeatable approach for writing, editing, and reviewing content. The docs-writer skill enforces voice guidelines and formatting rules across all .md files in the repository.

Do I need to specify a target audience when drafting Gemini CLI docs?

Yes, you should specify the desired tone and audience when drafting Gemini CLI docs. Providing the target file path and style guidelines allows the docs-writer skill to generate content that aligns with your specific project standards.