document-software

Create, reorganize, and maintain software project documentation scaled to project maturity and risk.

Updated Jul 9, 2026
One-click install
npx skills add https://github.com/akoita/agent-toolkit --skill document-software-akoita
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-software
Source: https://github.com/akoita/agent-toolkit/tree/main/plugins/claude/utilities/skills/document-software
Command: npx skills add https://github.com/akoita/agent-toolkit --skill document-software-akoita

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Software projects accumulate stale, duplicated, or missing documentation that drifts out of sync with the code. This Skill scaffolds new documentation trees, normalizes existing ones, and keeps docs accurate after material changes, using evidence from the repository rather than guesswork. ## Core Features & Use Cases - Documentation scaffolding: Create a right-sized docs structure (compact, standard, or operational profile) with README entry points, architecture overviews, ADRs, design docs, and runbooks. - Existing-tree normalization: Inventory and classify current documents by role, state, and authority, then execute a source-to-destination migration map that preserves links and history. - Lifecycle-aware authoring: Use adaptable templates for architecture overviews, design documents, ADRs, and runbooks with explicit status tracking (current, proposed, superseded, historical). - Use Case: After a major refactor changes your service's interfaces and deployment model, use this Skill to update the living architecture docs, record the consequential decisions as ADRs, and verify every link and command still matches the repository. ## Quick Start Use the document-software skill to audit this repository's documentation and scaffold the smallest structure that fits its maturity.

Frequently Asked Questions about document-software

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

FAQPage Schema
How do I scaffold documentation for a new software project?▼

Start by reading the repository's README, manifests, and source to identify audiences and project type, then choose a compact, standard, or operational profile. Create only justified files: a root README as the entry point, plus a docs map and architecture overview when the project warrants them.

How do I reorganize an existing messy docs folder?▼

Inventory each file by role, state, and authority, then build a source-to-destination migration map before moving anything. Merge duplicate sources of truth, update inbound links in the same change, and preserve established names that already communicate document roles clearly.

When should I write an architecture decision record?▼

Create an ADR only for a consequential decision whose rationale will matter later, not for routine implementation details. Number records sequentially, mark later changes as superseding records, and never silently rewrite an accepted decision's history.

What is the difference between a design doc and an ADR?▼

A design document explores a consequential unresolved change, covering drivers, alternatives, trade-offs, and verification. An ADR preserves one durable decision and its consequences at a point in time; design docs often precede and feed into ADRs.

When should I not create new documentation files?▼

Avoid creating empty category directories, speculative documents, or template sets in anticipation of future work. Skip design docs for obvious low-risk changes, and prefer linking to authoritative sources over copying configuration, schemas, or commands.