architecture-document-existing

Infer and document architecture from existing codebases as arc42-aligned docs.

Updated Jan 5, 2025
One-click install
npx skills add https://github.com/pkuppens/pkuppens --skill architecture-document-existing
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: architecture-document-existing
Source: https://github.com/pkuppens/pkuppens/tree/main/skills/architecture/architecture-document-existing
Command: npx skills add https://github.com/pkuppens/pkuppens --skill architecture-document-existing

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Infers and documents architecture from an existing codebase. Use when the codebase has some structure but lacks formal architecture documentation; retrofits arc42-aligned docs during onboarding or major refactors.

Core Features & Use Cases

  • Infer project purpose and build an initial architecture overview from code signals.
  • Generate arc42-aligned documentation (docs/architecture) and preserve an open-issues trail in 99-open-issues.md for unknowns.
  • Detect architecture drift and propose retrofitting steps to align code with design intent.

Quick Start

Run the skill on a codebase with missing architecture docs to generate arc42-aligned documentation and supporting artifacts.

Frequently Asked Questions about architecture-document-existing

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

FAQPage Schema
How do I generate architecture documentation for an existing undocumented codebase?

Generate architecture documentation for an undocumented codebase by scanning structural signals like README files, package manifests, and entry points to infer project purpose and produce arc42-aligned docs under docs/architecture.

What is arc42 documentation and when do I need to retrofit it?

Arc42 documentation is a structured template for capturing software architecture context, decisions, and building blocks. Retrofit it during onboarding or major refactors when a codebase has partial structure but lacks formal architecture docs.

Can I document architecture drift and track unknowns during a codebase refactor?

Detect architecture drift by comparing inferred code structure against design intent. The skill proposes retrofitting steps and logs unresolved unknowns in a 99-open-issues.md file for later investigation during refactors.

What code signals are needed to infer project purpose and build an architecture overview?

Inferring project purpose relies on scanning common code signals such as README files, package manifests, and application entry points. These artifacts provide the structural context needed to build an initial architecture overview.

Does this approach work for codebases with only partial structure and no formal docs?

Yes, this approach is designed for codebases that have some partial structure but lack formal architecture documentation. It works without dependencies and produces arc42-aligned docs plus an open-issues trail for unknowns.

What's the best way to onboard new developers onto a codebase with missing architecture docs?

Onboard developers by running the skill to infer architecture from code signals and generate arc42-aligned documentation under docs/architecture, providing a structured overview and an open-issues trail for unresolved unknowns.