doc-improve

Review documentation files against the codebase for accuracy and currency.

Updated Mar 30, 2026
One-click install
npx skills add https://github.com/weside-ai/claude-code-plugin --skill doc-improve
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-improve
Source: https://github.com/weside-ai/claude-code-plugin/tree/main/we/skills/doc-improve
Command: npx skills add https://github.com/weside-ai/claude-code-plugin --skill doc-improve

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill provides a comprehensive review of existing documentation files, ensuring they remain accurate, up-to-date, and clear for all readers.

Core Features & Use Cases

  • Content Review: Substantive review of documentation for factual accuracy, redundancy, staleness, and reader context.
  • Type-Specific Analysis: Different types of documentation, such as rules, architecture, and guides, are reviewed with specific criteria.
  • Code-Driven Verification: Every factual claim in the documentation is verified against the corresponding codebase.
  • Redundancy Detection: Identifies and addresses redundancy with sibling documents.
  • Currency Check: Ensures documentation reflects the current state of the codebase.
  • Format and Style Guidelines: Adherence to the project's documentation standards and formats.
  • Output Reporting: Provides a detailed report with findings and suggested changes.

Quick Start

Run the doc-improve skill on a specific documentation file or directory using the command: /we:doc-improve path/to/file.md

Frequently Asked Questions about doc-improve

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

FAQPage Schema
How do I review documentation for accuracy against my codebase?▼

To review documentation for accuracy, the skill substantively compares factual claims in your docs against the codebase to identify staleness, verify currency, and output a detailed report with suggested changes.

What is the best way to check for redundancy across sibling documentation files?▼

Checking for redundancy across sibling documentation files is handled by the skill's redundancy detection feature, which analyzes overlapping content within your project and provides suggestions to address duplicative information.

Can I use this to review different documentation types like architecture docs and guides?▼

Yes, you can review different documentation types like architecture and guides. The skill performs type-specific analysis, applying distinct review criteria to rules, architecture documents, and guides.

Do I need a codebase available to verify my documentation?▼

Yes, a codebase is required to verify your documentation. The tool performs code-driven verification by checking every factual claim in the document against the corresponding codebase.

How do I run a documentation review on a specific markdown file?▼

To run a documentation review on a specific markdown file, execute the command targeting your file path. The tool analyzes content, format, and style guidelines, then outputs a detailed findings report.