update_doc

Scan .dev_doc directories to audit documentation health and generate diagnostic reports.

5|1|Updated Apr 7, 2026
One-click install
npx skills add https://github.com/ayanjiushishuai/dev_toolkits --skill update-doc-ayanjiushishuai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update_doc
Source: https://github.com/ayanjiushishuai/dev_toolkits/tree/main/skills/update_doc
Command: npx skills add https://github.com/ayanjiushishuai/dev_toolkits --skill update-doc-ayanjiushishuai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill audits and updates project documentation by scanning for health, consistency, and obsolescence issues across the .dev_doc directory, helping teams maintain accurate and current docs without manual, repetitive checks.

Core Features & Use Cases

  • Documentation health audit: Detect stale, missing, or deprecated references and ensure alignment between code and docs.
  • Cross-project applicability: Works for any repository containing a .dev_doc/ folder to enforce documentation quality across projects.
  • Automated reporting and governance: Generates a diagnostic report and issue tracking to guide remediation efforts.

Quick Start

Run the audit on the project root to begin: Locate the .dev_doc/ directory, then execute the audit workflow to enumerate issues and generate the diagnostic report.

Frequently Asked Questions about update_doc

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

FAQPage Schema
How do I audit project documentation for stale references and obsolescence?

To audit project documentation for stale references, this Skill scans the .dev_doc directory to detect deprecated content, verify references, and compile a structured diagnostic report with remediation guidance. It uses glob, grep, and read operations to ensure alignment between code and docs.

How does a documentation health audit work for a software repository?

A documentation health audit works by scanning the .dev_doc directory to verify references, detect deprecated content, and identify missing or obsolete information. This Skill then generates a comprehensive diagnostic report to guide remediation efforts and enforce documentation consistency.

Can I use this documentation audit tool for any software project?

Yes, you can use this documentation audit tool for any software project that contains a .dev_doc folder. It applies cross-project to enforce documentation quality and consistency without requiring manual checks or specific external dependencies.

What is the best way to update and maintain markdown documentation health?

The best way to maintain markdown documentation health is automating the audit process. This Skill scans the .dev_doc directory using glob and grep to detect obsolescence and broken references, then produces an automated diagnostic report with issue tracking for governance.

Do I need specific dependencies to run a .dev_doc directory audit?

No specific external dependencies are required to run a .dev_doc directory audit. The Skill relies on standard glob, grep, and read operations to verify references and detect deprecated content, working in any repository containing the designated .dev_doc folder.

Why does my project documentation show obsolescence issues during audits?

Project documentation shows obsolescence issues during audits when references become stale or deprecated over time. This Skill scans the .dev_doc directory to identify these misalignments between code and docs, producing a structured report to guide targeted remediation.