Where are the audit reports stored?

Reports are saved to the .pack/reports/ directory with timestamped filenames and include YAML frontmatter for easy searching and aggregation.

Can I limit the audit to a specific folder?

Yes, you can use the path argument to restrict the audit scope to specific directories, such as 'docs/' or 'src/'.

Which programming languages are supported for docstring checks?

It currently supports TypeScript, JavaScript, Python, Rust, and Go for analyzing exported item documentation coverage.

How does it find stale documentation?

It uses a discovery script that compares git metadata of documentation files against recent changes in related source code to identify where docs likely lag behind implementation.

Does it check external website links?

While it prioritizes internal links and anchors to ensure repo integrity, it can perform sample checks on external URLs without blocking the audit process.

Documentation Audit & Accuracy

Name: Documentation Audit & Accuracy
Author: outfitter-dev

byoutfitter-dev

•

内容管理

Audits project documentation against source code to identify stale content, broken links, and missing docstrings.

关于

The Documentation Audit skill helps maintain high-quality documentation by verifying that markdown files, READMEs, and docstrings remain synchronized with your actual codebase. It identifies inaccurate code examples, detects broken internal and external links, and calculates docstring coverage across multiple languages like TypeScript, Python, Rust, and Go. By prioritizing stale files and providing structured markdown reports, it ensures your project's knowledge base stays reliable and up-to-date with minimal manual effort.

主要功能

Deep link validation for internal markdown, anchor references, and images
Intelligent discovery script to prioritize stale or recently changed files
Comprehensive report generation with YAML frontmatter for traceability
18 GitHub stars
Automated accuracy checks for code examples and function signatures
Multi-language docstring coverage analysis for TS, Python, Rust, and Go

使用场景

Identifying broken links and outdated setup instructions in large monorepos
Auditing docstring coverage to ensure high code quality and maintainability standards
Maintaining synchronization between API documentation and implementation during rapid development

关于

主要功能

Deep link validation for internal markdown, anchor references, and images
Intelligent discovery script to prioritize stale or recently changed files
Comprehensive report generation with YAML frontmatter for traceability
18 GitHub stars
Automated accuracy checks for code examples and function signatures
Multi-language docstring coverage analysis for TS, Python, Rust, and Go

使用场景

Identifying broken links and outdated setup instructions in large monorepos
Auditing docstring coverage to ensure high code quality and maintainability standards
Maintaining synchronization between API documentation and implementation during rapid development