docs

Audit documentation files against infrastructure code for accuracy and completeness.

Updated Feb 24, 2026
One-click install
npx skills add https://github.com/jkrumm/vps --skill docs-jkrumm
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/jkrumm/vps/tree/main/.claude/skills/docs
Command: npx skills add https://github.com/jkrumm/vps --skill docs-jkrumm

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that your project's documentation (README.md, CLAUDE.md) accurately reflects the current state of your infrastructure code (compose files, Makefiles, scripts), preventing drift and maintaining clarity.

Core Features & Use Cases

  • Automated Auditing: Diffs compose files against documentation tables, checks secret coverage, and verifies Makefile targets.
  • Consistency Checks: Flags inconsistencies in network documentation, middleware definitions, and upgrade procedures.
  • Use Case: After adding a new service to your Docker Compose setup, run this Skill to automatically verify that the service is correctly documented in your README and that all its environment variables are listed in the secrets section.

Quick Start

Run the docs skill to audit documentation against the current infrastructure.

Frequently Asked Questions about docs

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

FAQPage Schema
How do I audit README documentation against Docker Compose infrastructure?

To audit README documentation against Docker Compose, you can run a synchronization check that diffs compose files against documentation tables, verifying service inventory, network documentation, and middleware consistency to prevent drift.

What is documentation drift in infrastructure code and how is it detected?

Documentation drift occurs when project files like README.md no longer match the actual infrastructure code. It is detected by auditing compose files, Makefiles, and scripts to flag missing services, undocumented secrets, or outdated upgrade procedures.

How do I verify Makefile targets and secret coverage in my project documentation?

You can verify Makefile targets and secret coverage by running an automated audit that checks documentation files against your scripts and compose configurations, ensuring all environment variables and build commands are accurately listed.

Does documentation synchronization work with manually-managed Docker containers?

Yes, documentation synchronization works with manually-managed containers by scanning your infrastructure setup to identify any undocumented services that exist outside of your automated compose files and scripts.

Can I scan tracked infrastructure files for hardcoded sensitive data?

Yes, you can scan tracked infrastructure files for hardcoded sensitive data. The audit process includes searching your compose files, Makefiles, and scripts to detect and report any hardcoded secrets that should be moved to environment variables.

What is the best way to keep CLAUDE.md and README.md consistent with infrastructure scripts?

The best way to keep CLAUDE.md and README.md consistent is to run an automated synchronization audit that directly compares documentation against infrastructure code, verifying service inventory, network definitions, and middleware configurations.