docs-writer

Write, review, and edit .md documentation files in the /docs directory.

Updated Feb 12, 2026
One-click install
npx skills add https://github.com/yharuto0917/meChat --skill docs-writer-yharuto0917
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/yharuto0917/meChat/tree/main/.agents/skills/docs-writer
Command: npx skills add https://github.com/yharuto0917/meChat --skill docs-writer-yharuto0917

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that all documentation within the repository is accurate, clear, consistent, and adheres to established project standards, making it easier for users and contributors to understand and engage with the project.

Core Features & Use Cases

  • Writing & Editing: Creates new documentation or revises existing content.
  • Reviewing: Checks documentation for accuracy, clarity, and adherence to standards.
  • Formatting: Applies consistent styling, grammar, and structure.
  • Use Case: When a new feature is added to the Gemini CLI, this Skill can be used to write its corresponding documentation, ensuring it follows the project's voice, tone, and formatting guidelines.

Quick Start

Use the docs-writer skill to review and edit the file README.md for clarity and adherence to project standards.

Frequently Asked Questions about docs-writer

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

FAQPage Schema
How do I ensure my markdown documentation follows consistent voice and tone standards?

To ensure markdown documentation follows consistent standards, use a dedicated tool to review and edit files, strictly applying predefined guidelines for voice, tone, grammar, formatting, and structure across your repository.

What is the best way to write technical documentation for a new project feature?

The best way to write technical documentation for a new feature is to generate markdown files in your project's docs directory, ensuring the content adheres to strict technical writing standards for clear and accurate communication.

Can I automatically review existing markdown files for formatting and grammar issues?

Yes, you can automatically review existing markdown files for formatting and grammar issues by running an automated documentation editing process that checks content against established project standards and corrects discrepancies.

Does this documentation writing approach work specifically within the /docs directory?

Yes, this documentation writing approach specifically targets the /docs directory and markdown files within the repository, ensuring all generated or edited content maintains strict structural and formatting consistency.

How do I structure technical writing to make project contributions easier to understand?

To structure technical writing for better project comprehension, apply consistent formatting and clear language guidelines during the documentation editing process, ensuring accurate technical communication for all users and contributors.