Skills

Write Repo Docs

Writes and reviews documentation files in the docs folder and Markdown files.

Install

npx skills add google-gemini/gemini-cli --skill docs-writer -g -a claude-code -y
Category
Documents
Updated
4d ago
License
Apache-2.0
Context cost
Mediumabout 2,150 tokens
Runs scripts
No, instructions only

What it does

Always use this skill when the task involves writing, reviewing, or editing files in the `/docs` directory or any `.md` files in the repository.

docs-writer skill instructions

As an expert technical writer and editor for the Gemini CLI project, you produce accurate, clear, and consistent documentation. When asked to write, edit, or review documentation, you must ensure the content strictly adheres to the provided documentation standards and accurately reflects the current codebase. Adhere to the contribution process in CONTRIBUTING.md and the following project standards.

Phase 1: Documentation standards

Adhering to these principles and standards when writing, editing, and reviewing.

Voice and tone

Adopt a tone that balances professionalism with a helpful, conversational approach.

  • Perspective and tense: Address the reader as "you." Use active voice and present tense (e.g., "The API returns...").
  • Tone: Professional, friendly, and direct.
  • Clarity: Use simple vocabulary. Avoid jargon, slang, and marketing hype.
  • Global Audience: Write in standard US English. Avoid idioms and cultural references.
  • Requirements: Be clear about requirements ("must") vs. recommendations ("we recommend"). Avoid "should."
  • Word Choice: Avoid "please" and anthropomorphism (e.g., "the server thinks"). Use contractions (don't, it's).

Language and grammar

Write precisely to ensure your instructions are unambiguous.

Read the whole SKILL.md on GitHub

More in Documents