docs-writer

Write, review, and edit Gemini CLI documentation for style and accuracy.

Updated Jan 31, 2026
One-click install
npx skills add https://github.com/HiroyukiMakita/dev-kintone-plugin --skill docs-writer-hiroyukimakita
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/HiroyukiMakita/dev-kintone-plugin/tree/main/.opencode/skills/docs-writer
Command: npx skills add https://github.com/HiroyukiMakita/dev-kintone-plugin --skill docs-writer-hiroyukimakita

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures that all project documentation is accurate, clearly written, and adheres to established project standards, making it easy for users to understand and contribute.

Core Features & Use Cases

  • Documentation Writing & Editing: Generates, reviews, and refines documentation for clarity, accuracy, and adherence to style guides.
  • Codebase Alignment: Ensures documentation accurately reflects the current state of the codebase.
  • Use Case: When a new feature is added, use this Skill to write its corresponding user guide and technical documentation, ensuring all details are covered and the language is precise.

Quick Start

Use the docs-writer skill to review and edit the documentation in the /docs directory for clarity and accuracy.

Frequently Asked Questions about docs-writer

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

FAQPage Schema
Can I automatically review and edit markdown files for documentation accuracy?

You can review and edit markdown files for documentation accuracy by analyzing code and existing docs. This ensures documentation accurately reflects the current codebase state while adhering to specific voice, tone, grammar, and formatting standards.

How do I maintain consistent voice and tone in project documentation?

Maintain consistent voice and tone in project documentation by applying established structural and language standards. Reviewing text against specific style guidelines ensures clarity, accuracy, and consistency across all files within the docs directory.

Does this documentation writer work with standard markdown files?

This documentation writer works directly with standard markdown files. It specifically targets any `.md` files in the repository or files located within the `/docs` directory to ensure structural and formatting standards are met.

What is the best way to document a new feature for user guides?

The best way to document a new feature is to investigate the codebase first, then write the user guide. This ensures all technical details are covered accurately and the language remains precise, clear, and aligned with project standards.

When should I not use an automated documentation editor?

You should not use an automated documentation editor when code and existing documentation cannot be carefully investigated beforehand. Accurate writing and editing require understanding the current codebase state to prevent outdated or incorrect technical details.