document-project
Installation
SKILL.md
Document Project
Create or improve project documentation: a minimal root README.md that describes the project and links to a /docs directory containing all detailed pages. Every file and section is cross-linked so readers can navigate naturally. All diagrams are ASCII or Mermaid — no external image dependencies.
Phase 1: Understand the Project
Gather project signals
# Language / runtime / build tool
ls package.json pyproject.toml Cargo.toml go.mod pom.xml build.gradle \
Makefile CMakeLists.txt *.sln 2>/dev/null
# Entry points and structure
ls src/ app/ lib/ cmd/ internal/ main.* index.* 2>/dev/null
# Existing documentation (audit before creating anything)
find . -maxdepth 3 -name "*.md" -o -name "*.rst" -o -name "*.adoc" \
! -path "*/.git/*" ! -path "*/node_modules/*" 2>/dev/null