update-doc

Identify and reconcile discrepancies between implementation code and project documentation.

9|2|Updated Mar 4, 2026
One-click install
npx skills add https://github.com/typemd/typemd --skill update-doc-typemd
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-doc
Source: https://github.com/typemd/typemd/tree/main/.claude/skills/update-doc
Command: npx skills add https://github.com/typemd/typemd --skill update-doc-typemd

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Identify and prioritize documentation gaps and inaccuracies that arise when code, CLI commands, UI, or specs change so that releases and user-facing materials remain accurate.

Core Features & Use Cases

  • Comprehensive scan: discover and collect docs from README, docs sites, CLI help strings, marketplace READMEs, SKILL.md files, and openspec/specs.
  • Compare and categorize: detect missing pages, mismatched CLI flags or UI descriptions, spec divergences, and classify findings by severity (HIGH/MEDIUM/LOW).
  • Report and remediate: produce a prioritized discrepancy table, obtain user confirmation on scope, and update documentation following project conventions and frontmatter/sidebar rules.
  • Use Cases: pre-release audits, post-merge checks after feature additions, user requests to verify docs against implementation, and ensuring marketplace or plugin documentation stays accurate.

Quick Start

Run a repo-wide documentation audit comparing README, docs/, CLI help strings, and openspec/specs to produce a prioritized discrepancy report for user approval.

Frequently Asked Questions about update-doc

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

FAQPage Schema
How do I check if my project documentation matches the implementation code?

To check if documentation matches implementation, run a comprehensive audit that scans READMEs, docs sites, CLI help strings, and formal specs against source code to detect and categorize discrepancies by severity.

What's the best way to find mismatched CLI flags and UI descriptions before a release?

The best way to find mismatched CLI flags is to perform a pre-release audit that parses CLI help strings and compares them against implementation code to identify missing pages or divergent descriptions.

How do I categorize documentation discrepancies by severity during a code merge?

You categorize documentation discrepancies by comparing updated source files with existing docs, then classifying missing pages, mismatched CLI flags, and spec divergences into HIGH, MEDIUM, and LOW severity levels.

Does this documentation audit process update files automatically or require user confirmation?

The documentation audit process requires user confirmation, producing a prioritized discrepancy table for approval before implementing updates that follow project conventions and frontmatter rules.

When should I run a documentation reconciliation check on my repository?

You should run a documentation reconciliation check during feature additions, post-merge checks, and release preparations to ensure user-facing materials, marketplace READMEs, and formal specs remain accurate.