docs-writer
Always use this skill when the task involves writing, reviewing, or editing files in the `/docs` directory or any `.md` files in the repository.
Security Assessment
About docs-writer
The `docs-writer` skill is designed to assist in writing, editing, and reviewing technical documentation specifically for the Gemini CLI project. It ensures that all content within the `/docs` directory or any `.md` files adheres strictly to project documentation standards. By applying consistent rules for tone, grammar, formatting, and style, this skill solves the problem of inconsistent, unclear, or inaccurate documentation, helping maintain professional quality across the codebase and supporting materials.
The skill provides a comprehensive approach to documentation creation. It emphasizes a clear, professional, and conversational tone, uses active voice and present tense, and avoids jargon, idioms, or unnecessary embellishments. It enforces precise grammar, punctuation, and concise language while guiding the formatting of headings, lists, code snippets, UI elements, and media files. It also includes specific instructions for creating collapsible sections, callouts, and accessible content. Additionally, the skill ensures that terminology related to quotas and limits follows project guidelines and that all examples are meaningful and contextually relevant.
This skill is particularly useful for technical writers, developers, and contributors working on the Gemini CLI project who need to produce high-quality, maintainable documentation. Typical use cases include writing new guides or API references, reviewing and updating existing documentation to match current code functionality, and ensuring accessibility and formatting consistency. By using the `docs-writer` skill, teams can save time on editorial decisions, reduce errors, and provide end users with clear, reliable instructions and resources.
FAQ
When should I use the docs-writer skill?
You should use the docs-writer skill whenever you are writing, editing, or reviewing files in the `/docs` directory or any `.md` files in the Gemini CLI repository.
Does docs-writer work with non-Markdown files?
No, this skill is specifically designed for Markdown files (`.md`) within the Gemini CLI project and does not apply to other file types.
Are there any style guides I need to follow with this skill?
Yes, all documentation must adhere to the standards outlined in the skill instructions, including tone, grammar, formatting, and the `quota-limit-style-guide.md` for quota and limit terminology.
Can this skill help with accessibility requirements?
Yes, it enforces proper use of semantic HTML elements, descriptive alt text for images, and clear formatting to support accessibility.
Do I need prior knowledge of Gemini CLI to use docs-writer effectively?
While familiarity with the project is beneficial, the skill focuses on writing and formatting standards, ensuring that even new contributors can produce consistent documentation when following the guidelines.
Install docs-writer
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
google-gemini/gemini-cli