init-contracts

Generates contracts, architecture, and pattern docs from source code structure.

Updated Jan 5, 2026
One-click install
npx skills add https://github.com/Maxcogar/agent-armory --skill init-contracts
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: init-contracts
Source: https://github.com/Maxcogar/agent-armory/tree/main/workflows/codebase-documentation/setup-and-create/init-contracts
Command: npx skills add https://github.com/Maxcogar/agent-armory --skill init-contracts

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate source-of-truth documentation for a project by deriving it from actual source code, avoiding guesswork and ensuring accuracy.

Core Features & Use Cases

  • Produces docs/contracts/ directly from code structure
  • Creates docs/ARCHITECTURE.md and docs/patterns/ for architectural insights
  • Works on any stack and can bootstrap missing docs or refresh existing ones

Quick Start

Run init-contracts on a project to generate contracts and architecture docs when starting from scratch or when docs are missing.

Frequently Asked Questions about init-contracts

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

FAQPage Schema
How do I generate source-of-truth documentation directly from my codebase?

To generate source-of-truth documentation directly from a codebase, you can automate the derivation of contracts and architecture docs from actual source code, avoiding guesswork and ensuring accuracy by performing code inventory and entry-point identification.

What is the best way to document architecture and patterns for an existing project with missing docs?

The best way to document architecture and patterns for an existing project is to derive them from the actual code structure, creating files like docs/ARCHITECTURE.md and a docs/patterns/ directory to capture architectural insights without manual guesswork.

Can I auto-generate project contracts for any tech stack?

Yes, you can auto-generate project contracts for any tech stack. The process works by analyzing the code structure and deriving documentation directly, ensuring accurate docs are produced regardless of the underlying technology.

How do I ensure generated codebase docs stay accurate and up to date?

To ensure generated codebase docs stay accurate, the documentation process requires targeted reads of the actual code inventory and entry-point identification, ensuring the derived contracts and architecture files reflect the current source of truth.

When should I use automated code derivation instead of writing documentation manually?

You should use automated code derivation instead of writing documentation manually when you need to bootstrap missing docs or refresh existing ones, ensuring your contracts and architecture files are accurate by deriving them directly from the source code.