arn-code-document-project

Arness Document Project

Generate developer documentation for a completed feature or bug fix by reading plan artifacts, spec files, execution reports, and git diff to produce accurate, reference-heavy documentation.

Pipeline position:

arn-code-execute-plan -> arn-code-review-implementation -> **arn-code-document-project** -> arn-code-ship

This skill produces a single documentation file (or directory for complex projects) that captures what was actually built, how it diverges from the original plan, and where to find everything in the codebase.

Workflow

Step 1: Load Configuration

1. Read the project's CLAUDE.md and extract the ## Arness section to find:
   • Plans directory -- base path where project plans are saved
   • Specs directory -- path to the directory containing specification files
   • Code patterns -- path to the directory containing stored pattern documentation
   • Docs directory -- path to the directory where documentation is written
2. Template version check: If Template version and Template updates fields are present in the ## Arness section, run the template version check procedure from ${CLAUDE_PLUGIN_ROOT}/skills/arn-code-save-plan/references/template-versioning.md before proceeding. If these fields are not present, treat as legacy and skip.
3. Ask for PROJECT_NAME if not provided in the trigger message.
4. Verify the project directory exists with reports: <plans-dir>/<PROJECT_NAME>/reports/
5. If Docs directory is not in config, default to .arness/docs/

---

Step 2: Read Plan Artifacts

Read these files from <plans-dir>/<PROJECT_NAME>/:

1. INTRODUCTION.md -- project overview, goals, key decisions
2. SOURCE_PLAN.md -- original implementation plan
3. All phase plans in plans/PHASE_*.md -- acceptance criteria, expected files
4. All reports in reports/ -- implementation reports, testing reports
5. PROGRESS_TRACKER.json -- overall completion status (if it exists)