docs-writer

Write and edit repository Markdown documentation to match Gemini CLI standards.

17|2|Updated Mar 5, 2026
One-click install
npx skills add https://github.com/DavidLiuXh/jarvis-personal-ai --skill docs-writer-davidliuxh
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/DavidLiuXh/jarvis-personal-ai/tree/main/.gemini/skills/docs-writer
Command: npx skills add https://github.com/DavidLiuXh/jarvis-personal-ai --skill docs-writer-davidliuxh

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

You can use this Skill to produce accurate, consistent documentation and edits for Gemini CLI, especially when changes must reflect the current codebase and contribution standards.

Core Features & Use Cases

  • Documentation writing and editing: Draft new or revise existing content in /docs and for repository Markdown files.
  • Standards-based review: Enforce voice, tone, formatting, structure, and naming conventions (including link, grammar, and clarity checks).
  • Codebase accuracy checks: Verify claims against the latest relevant materials (primarily packages/) before finalizing edits.

Quick Start

Use the docs-writer skill to update the documentation for the feature described in your request by following Gemini CLI’s documentation standards and the contribution process.

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 repository documentation follows contribution standards?

To ensure repository documentation follows contribution standards, enforce voice, tone, formatting, and structure conventions. Verify links, grammar, and clarity before finalizing edits to maintain consistency across all Markdown files.

What is the best way to update existing Markdown files to match current codebase behavior?

Updating existing Markdown files requires verifying documentation claims against the latest relevant materials, primarily the codebase packages. This ensures the revised content accurately reflects current behavior before changes are finalized.

How do I draft new technical documentation for a repository?

Drafting new technical documentation involves creating content in the /docs directory and Markdown files. It requires strict adherence to project documentation conventions, formatting rules, and contribution guidance to maintain consistency.

Does documentation editing require link and consistency verification before submitting?

Yes, documentation editing requires strict link and consistency verification before finalizing changes. This process enforces naming conventions, checks grammar, and validates formatting to ensure accurate, standards-compliant writing.

Can I use this approach to review existing documentation pages for accuracy?

Yes, you can review existing documentation pages for accuracy by performing standards-based reviews. This enforces voice, tone, and formatting rules while checking claims against the latest codebase materials.

When do I need to verify documentation claims against the codebase packages?

You need to verify documentation claims against the codebase packages before finalizing any edits. This accuracy check ensures that updated content correctly reflects the latest behavior and implementation details.