graph-docs

Audit documentation health by validating JSDoc, README, and CLAUDE.md conventions.

Updated Apr 26, 2026
One-click install
npx skills add https://github.com/luissimon96/orchestration-devops-agents --skill graph-docs-luissimon96
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: graph-docs
Source: https://github.com/luissimon96/orchestration-devops-agents/tree/main/.agents/skills/graph-docs
Command: npx skills add https://github.com/luissimon96/orchestration-devops-agents --skill graph-docs-luissimon96

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill streamlines the process of maintaining documentation in sync with the codebase, ensuring completeness and accuracy across all relevant documentation aspects.

Core Features & Use Cases

  • Documentation Audit: Comprehensive audit of JSDoc, README freshness, CLAUDE.md convention coverage, API documentation, and architecture documentation.
  • Code-to-Document Alignment: Ensures that the documentation accurately reflects the codebase.
  • Use Case: Ideal for pre-handoff checks, quarterly reviews, new developer onboarding, and significant changes to CLAUDE.md.

Quick Start

Run the graph-docs skill to perform a full documentation health audit.

Frequently Asked Questions about graph-docs

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

FAQPage Schema
How do I automate a documentation health audit for JSDoc and README files?

A documentation health audit validates the completeness of JSDoc comments, README freshness, CLAUDE.md convention adherence, and API documentation. Running this skill generates an audit report that highlights missing or outdated documentation across the codebase.

What is code-to-document alignment and how does it work?

Code-to-document alignment ensures that documentation accurately reflects the codebase. This skill validates JSDoc coverage, API documentation, and architecture docs against the actual code to identify discrepancies and maintain accuracy.

How do I check CLAUDE.md convention coverage and compliance in my project?

Checking CLAUDE.md convention coverage involves validating project adherence to defined conventions. This skill utilizes internal scripts to perform compliance checks, ensuring your codebase aligns with the rules specified in your CLAUDE.md file.

Can I use this documentation audit for pre-handoff checks and onboarding?

Yes, this documentation audit is ideal for pre-handoff checks, quarterly reviews, new developer onboarding, and significant changes to CLAUDE.md. It ensures all relevant documentation aspects are complete and accurate before major project transitions.

What's the best way to maintain JSDoc comments and API documentation freshness?

Maintaining JSDoc comments and API documentation freshness requires regular validation against the codebase. This skill performs comprehensive checks on JSDoc coverage, validates example code, and generates an audit report to keep documents up-to-date.

Are there limitations when validating architecture documentation with automated scripts?

Limitations depend on the internal and external scripts used for checks like JSDoc coverage and example code validation. While the audit validates architecture documentation and CLAUDE.md compliance, complex structural logic may require manual review beyond the generated report.