Which documentation files are scanned by default?

It typically scans README.md, CLAUDE.md, .env.example, SKILL.md files, and significant inline documentation like Python docstrings.

How does the skill verify environment variables?

It cross-references variables mentioned in the documentation against keys in the project's configuration schemas and environment maps found in the source code.

Can this skill handle Docker-specific documentation?

Yes, it checks build arguments, Docker image names, and port numbers mentioned in docs against the actual Dockerfile and docker-compose.yml files.

Does it automatically update my files?

Yes, the skill can identify stale items and use the Edit tool to apply fixes directly to your documentation files after explaining the changes.

Documentation Auditor

Name: Documentation Auditor
Author: jinglemansweep

byjinglemansweep

0•

学習とドキュメンテーション

Audits and synchronizes project documentation with the actual codebase to ensure accuracy, completeness, and functional reliability.

The Documentation Auditor skill automates the critical task of keeping project documentation in sync with evolving source code. It performs a deep analysis of README files, configuration examples, and skill definitions to verify that environment variables, file paths, and feature descriptions are perfectly aligned with the codebase. By identifying gaps—such as missing documentation for new features or references to deprecated logic—and applying direct fixes, it ensures your project's documentation remains a reliable and up-to-date source of truth for all contributors.

主な機能

010 GitHub stars

02Validation of file paths and command examples for accuracy

03Automatic identification and patching of stale or missing docs

04Automated inventory of all project documentation files

05Cross-referencing of environment variables against config schemas

06Verification of Docker build arguments and port configurations

ユースケース

01Onboarding new developers with guaranteed accurate setup guides

02Synchronizing .env.example files with application configuration logic

03Pre-release validation to ensure all new features are fully documented

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jinglemansweep/nanobot-nix documentation

For use in Claude.ai and ChatGPT

Download Skill