documentation-audit
Maintains alignment between BioETL documentation and technical standards.
Install
mkdir -p .claude/skills/documentation-audit && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/16535" && unzip -o skill.zip -d .claude/skills/documentation-audit && rm skill.zipInstalls to .claude/skills/documentation-audit
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Full audit and update of BioETL project documentation for v5.23+. Use when asked to review docs for staleness, reconcile docs with code, sync RULES.md and REQUIREMENTS.md, update architecture/provider/contract docs, reflect ADR-010/ADR-014/ADR-017, or identify dead documentation.Key capabilities
- →Compare documentation to current code and configurations
- →Check alignment with accepted Architecture Decision Records (ADRs)
- →Record findings with severity levels (Critical, High, Medium, Low)
- →Generate a prioritized plan for documentation updates
- →Edit documentation to match current code and ADRs
- →Verify links and navigation entries in `mkdocs.yml`
How it works
The skill performs a complete audit of BioETL documentation by comparing it against code, configurations, and ADRs. It identifies discrepancies, records findings with severity, and generates a plan for updates, which can then be applied.
Inputs & outputs
When to use documentation-audit
- →Syncing RULES.md and REQUIREMENTS.md
- →Updating architecture documentation
- →Aligning docs with ADR-010/014
- →Identifying outdated project files
About documentation-audit
Performs a complete documentation audit to reconcile docs with current code, ADRs, and project rules. It identifies dead documentation and produces a prioritized update plan.
Full audit and update of BioETL project documentation for v5.23+. Use when asked to review docs for staleness, reconcile docs with code, sync RULES.md and REQUIREMENTS.md, update architecture/provider/contract docs, reflect ADR-010/ADR-014/ADR-017, or identify dead documentation.
When not to use it
- →When changing code without explicit user request
- →When removing documentation without explicit user approval
- →When documenting desired behavior instead of reality when code and docs diverge
Limitations
- →Must use `references/report-template.md` for the audit report structure
- →Must not change code unless explicitly requested
- →Must not remove docs without explicit user approval
How it compares
This skill provides a structured audit and update process for BioETL documentation, focusing on reconciliation with code and ADRs, unlike a general document review.
Compared to similar skills
documentation-audit side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| documentation-audit (this skill) | 0 | 1mo | Review | Advanced |
| codebase-documenter | 6 | 9mo | No flags | Beginner |
| c4-architecture-c4-architecture | 1 | 4mo | Review | Advanced |
| code-documentation-doc-generate | 1 | 4mo | No flags | Intermediate |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by SatoryKono
View all by SatoryKono →You might also like
codebase-documenter
mhattingpete
Generates comprehensive documentation explaining how a codebase works, including architecture, key components, data flow, and development guidelines. Use when user wants to understand unfamiliar code, create onboarding docs, document architecture, or explain how the system works.
c4-architecture-c4-architecture
sickn33
Generate comprehensive C4 architecture documentation for an existing repository/codebase using a bottom-up analysis approach.
code-documentation-doc-generate
sickn33
You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI-powered analysis and industry best practices.
deepwiki-rs
sopaco
AI-powered Rust documentation generation engine for comprehensive codebase analysis, C4 architecture diagrams, and automated technical documentation. Use when Claude needs to analyze source code, understand software architecture, generate technical specs, or create professional documentation from any programming language.
specification-architect
adrianpuiu
A rigorous, traceability-first system that generates five interconnected architectural documents (blueprint.md, requirements.md, design.md, tasks.md, and validation.md) with complete requirements-to-implementation traceability. Use this skill when users need to architect systems, create technical specifications, or develop structured project documentation with guaranteed traceability.
business-analyst-authority
ahmedemad3
Act as a Principal Business Analyst (8+ years exp) bridging the gap between Strategy and Execution. Specializes in translating vague vision into rigorous technical specifications using Gherkin (BDD), BPMN 2.0, and strict Requirement Engineering standards.