managing-doc-manifest
Skill0 starsChanged 9 months agoMITView on GitHub
Creates and maintains .doc-manifest.yaml files tracking project documentation. Lists all docs, their types, last-updated timestamps, and code references. Activates when user asks to "create doc manifest", "update manifest", "doc inventory", "list docs", or mentions documentation tracking.
In this repository17 other files it gives its agents.
- AGENTS.mdAGENTS.md
- auditing-skillsSkill
- creating-skillsSkill
- forge-builderSkill
- forge-claude-teamsSkill
- forge-codex-multiagentSkill
- forge-orchestratorSkill
- forge-researchSkill
- handoff-freshSkill
- handoffSkill
- okfSkill
- pickupSkill
- studySkill
- syncing-docsSkill
- testing-skillsSkill
- updating-skillsSkill
- wrapSkill
The file
We split this skill into the rules it gives an agent
4 rules. About 0 are common, 2 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 33
Read .doc-manifest.yaml if it exists.
- Distinctive: line 129
When updating an existing manifest:
- Very specific: line 185
Update last_synced and last_updated after applying changes
- Distinctive: line 189
Update this skill when:
≈ “Common” is an estimate: at least 1 in 5 of the 372,429 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Managing Doc Manifest
Creates and maintains .doc-manifest.yaml — a registry of all documentation files in a project, what code they reference, and when they were last updated.
Workflow
- 1. Check for existing
.doc-manifest.yaml - 2. Scan project for documentation files
- 3. Analyze each doc for code references
- 4. Write/update
.doc-manifest.yaml - 5. Show summary
Step 1: Check Existing Manifest
Read .doc-manifest.yaml if it exists. Compare against current state.
Step 2: Scan for Documentation
Auto-discover all documentation files:
# Standard locations
CLAUDE.md
README.md
ARCHITECTURE.md
CHECKLIST.md
CHANGELOG.md
CONTRIBUTING.md
docs/**/*.md
*.md (project root)Exclude:
node_modules/**venv/**,.venv/**.git/****/CHANGELOG.mdinside dependencies
Step 3: Analyze Code References
For each doc file, extract referenced code files:
Detection Methods
- Explicit paths:
src/validators/comparator.pymentioned in text - Code blocks: File paths in fenced code blocks (
bash,python) - Table entries: File paths in markdown tables
- Import references:
from src.models import ...patterns
Reference Types
| Type | Example | Detection |
file | src/main.py | Path-like string that matches existing file |
directory | src/validators/ | Path ending with / |
glob | src/**/*.py | Path with wildcards |
command | pytest tests/ -v | Executable in code block |
Step 4: Write Manifest
Schema
# .doc-manifest.yaml
# Auto-generated by managing-doc-manifest skill
# Manual edits are preserved on re-scan
version: "1.0"
last_synced: "{current ISO-8601 timestamp}"
files:
- path: CLAUDE.md
type: claude-instructions
last_updated: "{file modification timestamp}"
references:
- src/validators/comparator.py
- src/validators/preflight.py
- config/settings.yaml
- main.py
- path: README.md
type: readme
last_updated: "{file modification timestamp}"
references:
- main.py
- requirements.txt
- path: docs/ARCHITECTURE.md
type: architecture
last_updated: "{file modification timestamp}"
references:
- src/**/*.py
- config/*.yamlDocument Types
| Type | Description |
claude-instructions | CLAUDE.md files (project or directory-level) |
readme | README.md |
architecture | ARCHITECTURE.md or similar design docs |
checklist | CHECKLIST.md, TODO.md, progress tracking |
changelog | CHANGELOG.md |
guide | User guides, tutorials, how-to docs |
api | API documentation |
other | Any other .md file |
Update Rules
When updating an existing manifest:
- Preserve manually added entries (files not found by auto-scan)
- Add newly discovered files
- Remove entries for deleted files (mark with comment if unsure)
- Update
last_updatedtimestamps from file system - Update
referencesby re-scanning doc content - Always update
last_syncedto current time
Step 5: Show Summary
=== Doc Manifest Summary ===
File: .doc-manifest.yaml
Tracked: 5 documentation files
CLAUDE.md (claude-instructions) - refs: 4 code files
README.md (readme) - refs: 2 code files
docs/ARCHITECTURE.md (architecture) - refs: 2 glob patterns
CHECKLIST.md (checklist) - refs: 0
docs/guide.md (guide) - refs: 3 code files
New: 1 file added (docs/guide.md)
Removed: 0 files
Updated references: 2 files (CLAUDE.md, docs/ARCHITECTURE.md)Example
Input:
/doc-manifestContext: Project at /home/user/projects/my-app/ with CLAUDE.md, ARCHITECTURE.md, CHECKLIST.md.
Output:
=== Doc Manifest Summary ===
Created: .doc-manifest.yaml
Tracked: 4 documentation files
CLAUDE.md (claude-instructions) - refs: 7 code files
docs/ARCHITECTURE.md (architecture) - refs: 5 code files
CHECKLIST.md (checklist) - refs: 0
docs/API.md (api) - refs: 3 code files
Path: /home/user/projects/my-app/.doc-manifest.yamlIntegration with syncing-docs
The syncing-docs skill uses this manifest to:
- Know which docs to check for staleness
- Know which code files each doc references (for targeted reads)
- Update
last_syncedandlast_updatedafter applying changes
Self-Evolution
Update this skill when:
- On missed doc file: Auto-discovery didn't find a doc → add pattern to Step 2
- On missed reference: Code path in doc not detected → add detection method to Step 3
- On schema change: New metadata needed → update schema in Step 4
Applied Learnings:
- v1.0.0: Initial version
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

