skills.rest
Vrooli
VrooliOFFICIAL
Explore all skills by this author →
Website𝕏@VrooliOfficialGitHub

Documentation Health

Audit documentation manifests and references for gaps, duplication, and orphaned material.

54|7|Updated Sep 19, 2021
Search Tags:#documentation#audit#manifest#traceability#knowledge-observatory
One-click install
npx skills add https://github.com/Vrooli/Vrooli --skill documentation-health
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Documentation Health
Source: https://github.com/Vrooli/Vrooli/tree/main/scenarios/prompt-manager/store/skills/packs/core/documentation-health
Command: npx skills add https://github.com/Vrooli/Vrooli --skill documentation-health

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation quality drifts when code evolves without bidirectional traceability, manifests fall out of sync, and agents keep re-creating the same explanations, leaving gaps, duplication, and orphaned knowledge.

Core Features & Use Cases

  • Hierarchy enforcement: Keeps content aligned with PRD, operational targets, technical requirements, implementation docs, and code so every artifact has a place in the screaming-architecture hierarchy.
  • Reference validation: Validates [CODE:] links, // DOC: comments, manifest registrations, and protective callout patterns to ensure discoverability and correctness.
  • Audit tooling: Runs knowledge-observatory documentation audits that flag missing manifests, broken references, duplicate titles, and undocumented operational targets.

Quick Start

Run the documentation health audit with knowledge-observatory targeting this scenario before touching code.

Frequently Asked Questions about Documentation Health

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

FAQPage Schema
How do I audit documentation manifests to find broken references and orphaned content?▼

Documentation audits validate bidirectional [CODE:] and // DOC: references against registered manifests, surfacing missing entries, broken links, duplicate titles, and orphaned material before code iterations merge.

What is bidirectional traceability in documentation and why do I need it?▼

Bidirectional traceability links code to docs using [CODE:] references and // DOC: comments, ensuring every artifact has a place in the hierarchy and preventing knowledge gaps during code evolution.

How do I keep documentation aligned with code changes during CI?▼

Run a documentation health audit during CI to validate manifests, check protective callout patterns, and enforce alignment between PRDs, technical requirements, and implementation docs before updates.

Can I use a documentation audit to enforce hierarchy across PRDs and implementation docs?▼

Yes, the audit enforces screaming-architecture hierarchy by checking that every operational target, technical requirement, and implementation doc is registered in the manifest and properly linked.

Why does my documentation drift out of sync when code evolves?▼

Documentation drifts when manifests fall out of sync without bidirectional traceability, causing agents to recreate existing explanations and leaving gaps, duplicate titles, and orphaned knowledge artifacts behind.

Related Skills

Explore More Software Engineering Skills→
TheBushidoCollectiveTheBushidoCollective
187

documentation-linking

Establish bidirectional links between code and documentation with multiple link formats.

Official
Basic
VrooliVrooli
54

Screaming Architecture

Audit scenario architecture alignment across documentation, code structure, and naming.

Official
Advanced
hey-konghey-kong

add-sgl-kernel

Implement and integrate CUDA/C++ kernels with tests and benchmarks.

Community
Advanced
Pabloprogramador23Pabloprogramador23

reversa-audit

Compare requirements.md, roadmap.md, and actions.md for inconsistencies and coverage gaps.

Community
Advanced