docs-organization

Organizes, archives, and audits the docs/ directory tree and its README catalogs.

Updated Jul 29, 2026
One-click install
npx skills add https://github.com/chris-prener/dev-kit --skill docs-organization-chris-prener
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-organization
Source: https://github.com/chris-prener/dev-kit/tree/main/dev-kit/skills/docs-organization
Command: npx skills add https://github.com/chris-prener/dev-kit --skill docs-organization-chris-prener

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation trees drift over time: new docs land in the wrong place, superseded files linger, README catalogs fall out of sync with the actual files, and stale or orphaned pages accumulate. This Skill enforces placement, archival, and freshness conventions across the docs/ directory so the structure stays consistent. ## Core Features & Use Cases - Doc placement and archival: Places new docs in the correct location with kebab-case or ALL-CAPS naming, and retires superseded docs to docs/archive/<YYYY>/ with an archival header and optional redirect stub. - Whole-tree audits: Reports orphan docs, missing or stale frontmatter, broken relative links, and naming drift, with WARNING findings auto-filed as backlog issues. - README catalog refresh: Regenerates a directory's README catalog from the actual file inventory while preserving operator-authored prose. - Use Case: After a quarter of ad-hoc writing, run an audit to find orphaned and stale docs, archive the superseded ones, and regenerate each directory's README catalog so the docs tree matches reality. ## Quick Start Ask the assistant to audit the docs/ directory for orphans, stale frontmatter, and broken links, then refresh the README catalogs.

Frequently Asked Questions about docs-organization

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

FAQPage Schema
How do I organize a docs folder in a software project?▼

Use a placement convention: kebab-case filenames for subfolder docs, ALL-CAPS for top-level state-of-the-project docs, and a per-directory README catalog. This Skill applies those rules when adding docs and regenerates catalogs from the actual file inventory.

How do I archive a superseded documentation file?▼

Move the file to docs/archive/<YYYY>/ with git mv, prepend an 'Archived YYYY-MM-DD' header noting what superseded it, and remove it from the active README catalog. Optionally leave a one-line redirect stub at the original path.

How do I find orphaned or stale documentation pages?▼

Run a whole-tree audit that flags files not linked from any directory README, docs whose last_updated frontmatter is older than 180 days, broken relative links, and naming drift. WARNING findings can be auto-filed as backlog issues.

Can this skill archive ADRs or the changelog?▼

No. ADRs are append-only history handled by the adr skill, and CHANGELOG.md, ARCHITECTURE.md, ROADMAP.md, OBJECTIVES.md, and GLOSSARY.md are updated in place by their owner skills. This skill rejects archival requests for those docs.

What are the limitations of automated docs audits?▼

The audit reports findings but does not auto-rewrite content or rename files, since renames would break cross-references. Stale-frontmatter findings are informational nudges only and are not auto-filed as issues.