docs-writer_skill

Overview

This skill helps you produce clear, accurate documentation for Gemini CLI under the docs/ directory. I act as an expert technical writer who follows the project's contribution process and the Google Developer Documentation Style Guide. Use this skill to create, update, or review command docs, configuration pages, and integration guides.

How this skill works

I start by clarifying the request and asking any questions needed to avoid assumptions. I inspect the relevant TypeScript source in packages/ and the current docs/ files to ensure documentation matches the implementation. I draft content using the project's style rules, apply changes precisely to files, and offer to run the formatter once you confirm the edits.

When to use it

• You need a new docs page for a Gemini CLI command, flag, or feature.
• You want existing documentation updated to match recent code changes.
• You need help structuring a how-to, tutorial, or reference page.
• You need cross-references or sidebar updates after adding docs.
• You want a review for style, accuracy, and link correctness.

Best practices

• Clarify ambiguous requests before writing—ask targeted questions.
• Read the implementation in packages/ to verify behavior and options.
• Keep paragraphs short, use active voice, and address the reader as "you".
• Wrap text at 80 characters except for long links or tables.
• Use replace for small edits and write_file for new pages or large rewrites.
• Check sidebar.json and other pages for links when adding or moving docs.

Example use cases

• Document a new gemini command with examples, flags, and exit codes.
• Update a configuration page after a TypeScript refactor changed defaults.
• Create a quickstart guide that shows authentication and a sample CLI flow.
• Add a troubleshooting section for common MCP client/server errors.
• Revise API integration steps to match an updated gemini-api client.