docs-system

Bootstrap and migrate project documentation to a structured taxonomy with maps, frontmatter, and PDF guides.

Updated Jun 2, 2026
One-click install
npx skills add https://github.com/lfuuu/claude-rules --skill docs-system-lfuuu
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-system
Source: https://github.com/lfuuu/claude-rules/tree/main/global-skills/docs-system
Command: npx skills add https://github.com/lfuuu/claude-rules --skill docs-system-lfuuu

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pandoc, wkhtmltopdf, and includes references (resource) components.

What problem does it solve? Project documentation is often scattered, inconsistent, or missing entirely, making it hard for developers, users, and AI agents to find reliable information. This Skill establishes a complete documentation system from scratch or migrates existing docs into a single standard: one entry-point map, a purpose-based directory taxonomy, frontmatter conventions, and user guides compiled into PDF. ## Core Features & Use Cases - Bootstrap or migrate docs: The init mode scaffolds a skeleton (map, taxonomy directories, glossary, diagrams) while migrate inventories existing files, plans git-history-preserving moves, and fills gaps. - Session-persistent progress tracking: A versioned manifest (docs/.docs-system/progress.md) plus per-document status frontmatter lets work resume across sessions without replanning. - Golden-data quality gates: Articles get code-grounded citations (file:line), a machine-readable docs-index.json, and automated checks for broken citations, metadata uniformity, and doc/code drift. - Orchestration of specialized skills: Delegates data-model docs to db-docs, diagrams to diagram, PDF compilation to pdf, and C4 architecture to c4-architecture. - Use Case: Ask it to "bring order to docs" in a legacy repository; it inventories all Markdown files, proposes a migration plan for approval, moves files with git mv, adds frontmatter and indexes, and produces a user-guide PDF. ## Quick Start Ask the agent to run docs-system in init mode to scaffold a documentation skeleton for this project, or in migrate mode to reorganize the existing docs folder.

Frequently Asked Questions about docs-system

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

FAQPage Schema
How do I set up project documentation from scratch?

Run the skill in init mode: it creates a docs skeleton with a README map, taxonomy directories with index stubs, a glossary, and diagrams/pics folders. You first approve which taxonomy categories apply to your project before anything is written.

How to migrate scattered Markdown docs into a structured docs folder?

Use migrate mode: it inventories all Markdown files, classifies each into the taxonomy, and produces a move plan for your approval. Files are relocated with git mv to preserve history, then frontmatter, indexes, and the map are added.

Can documentation work resume after the AI session restarts?

Yes. Progress lives in the repository, not in memory: a versioned manifest at docs/.docs-system/progress.md holds the plan, backlog checkboxes, and session journal, while each document's frontmatter status is the source of truth for readiness.

Does it generate a PDF user guide from Markdown docs?

Yes, via the delegated pdf skill in multi mode. You define an ordered doc-order-guides.txt list, and the build script uses pandoc with wkhtmltopdf to produce a PDF with title page, table of contents, and page breaks.

How does it keep documentation accurate as code changes?

Articles carry file:line citations verified by check-citations.sh against git ls-files, plus a drift.py tool that flags articles whose source files changed since a recorded commit anchor. A check-all.sh run combines index, citation, and metadata checks.

What are the limitations of the docs-system approach?

Irreversible file moves require an approved plan first, and commits happen only on explicit request. PDF builds depend on pandoc and wkhtmltopdf being installed, and citation checks require a working git checkout.