arn-code-document-project

Generate developer documentation from Arness pipeline artifacts and git diffs.

31|3|Updated Apr 3, 2026
One-click install
npx skills add https://github.com/AppsVortex/arness --skill arn-code-document-project
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: arn-code-document-project
Source: https://github.com/AppsVortex/arness/tree/main/plugins/arn-code/skills/arn-code-document-project
Command: npx skills add https://github.com/AppsVortex/arness --skill arn-code-document-project

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the creation of developer documentation for completed features or bug fixes by turning plan artifacts, specs, execution reports, and diffs into a single, reference-heavy document.

Core Features & Use Cases

  • Reads INTRODUCTION.md, SOURCE_PLAN.md, and all phase plans (plans/PHASE_*.md) along with execution reports to build comprehensive documentation.
  • Analyzes git diffs to explain how the built product diverged from the plan and to highlight key changes.
  • Produces a single Markdown file or a directory of docs under the configured docs path, with references to exact code locations.
  • Keeps documentation aligned with the codebase by citing precise file paths and artifacts.

Quick Start

Trigger the skill with PROJECT_NAME to generate documentation from the project’s latest pipeline artifacts.

Frequently Asked Questions about arn-code-document-project

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

FAQPage Schema
How do I generate developer documentation from git diffs and execution reports?

Developer documentation generation from git diffs and execution reports works by reading pipeline artifacts like plan files and execution logs, then producing a single Markdown file with precise codebase references. It captures what was built and how it diverged from the plan.

What is the best way to document feature divergences from a project plan?

Documenting feature divergences from a project plan involves analyzing git diffs against original specs and execution reports to highlight key changes. This produces reference-heavy documentation explaining what was built and where to find it in the codebase.

Can I automate feature docs creation from pipeline artifacts?

Automating feature docs from pipeline artifacts is possible by reading INTRODUCTION.md, SOURCE_PLAN.md, and phase plans alongside execution reports. It outputs a single documentation file or directory with references to exact code locations.

How do I keep documentation aligned with the codebase after a bug fix?

Keeping documentation aligned with the codebase after a bug fix requires citing precise file paths and artifacts from execution reports and git diffs. This ensures the resulting Markdown documentation accurately reflects the built product.

Does pipeline artifact documentation work without external dependencies?

Pipeline artifact documentation generation requires no external dependencies, relying solely on existing pipeline artifacts like plan files, specs, and git diffs to produce comprehensive reference-heavy documentation for completed features.

What pipeline artifacts are needed to generate accurate feature documentation?

Generating accurate feature documentation requires INTRODUCTION.md, SOURCE_PLAN.md, all phase plans, execution reports, and git diffs. These pipeline artifacts provide the context needed to capture what was built and where to find everything in the codebase.