Can I limit the audit to a specific directory?

Yes, you can use the 'path' parameter to focus the audit on specific scopes like the 'docs/' folder or specific 'src/' directories.

How does the Documentation Auditor identify stale files?

It uses git metadata to compare the last modified date of documentation files against recent changes in related source code directories to find potential inaccuracies.

Which programming languages are supported for docstring checks?

The skill currently supports TypeScript, JavaScript, Python, Rust, and Go for calculating documentation coverage of exported items.

Where are the audit reports stored?

Reports are saved by default to the '.pack/reports/' directory with timestamps and session IDs, which can be gitignored or committed for history.

Documentation Auditor

Name: Documentation Auditor
Author: outfitter-dev

byoutfitter-dev

•

학습 및 문서화

Audits project documentation against the current codebase to ensure accuracy, valid links, and comprehensive docstring coverage.

Documentation Auditor is a specialized Claude Code skill designed to keep technical documentation in sync with evolving codebases. It automatically discovers markdown files, prioritizes stale content based on git history, and performs deep analysis on code examples, function signatures, and internal links. By calculating docstring coverage across multiple languages like TypeScript, Python, Rust, and Go, it helps maintain high-quality API documentation and prevents documentation rot in fast-moving projects.

주요 기능

01Internal and anchor link verification to prevent broken documentation paths.

02Validation of code examples, imports, and function signatures against source code.

03Detailed reporting with searchable YAML frontmatter for historical tracking.

04Automated discovery of stale documentation based on git metadata and code changes.

05Multi-language docstring coverage analysis for TS, Python, Rust, and Go.

062 GitHub stars

사용 사례

01Identifying documentation debt by flagging docs that haven't kept pace with code updates.

02Improving API reliability by enforcing docstring coverage across exported functions.

03Performing pre-release documentation sanity checks to ensure all examples are functional.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add outfitter-dev/outfitter docs-audit

For use in Claude.ai and ChatGPT

Download Skill