skills.rest
Junkfooooood
JunkfoooooodCOMMUNITY
Explore all skills by this author →
GitHub

project-architecture-documentation

Generate Markdown architecture documentation from existing project files, configs, and code comments.

Updated May 4, 2026
Search Tags:#architecture#documentation#markdown#onboarding#system design#codebase analysis#handoff
One-click install
npx skills add https://github.com/Junkfooooood/hermes-governance --skill project-architecture-documentation-junkfooooood
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: project-architecture-documentation
Source: https://github.com/Junkfooooood/hermes-governance/tree/main/skills/software-development/project-architecture-documentation
Command: npx skills add https://github.com/Junkfooooood/hermes-governance --skill project-architecture-documentation-junkfooooood

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Understanding an unfamiliar codebase well enough to document its architecture is slow and error-prone. This Skill systematically analyzes a repository's files, configs, docs, and code comments to produce a comprehensive Markdown architecture document suitable for onboarding and handoff. ## Core Features & Use Cases - Subsystem Mapping: Identifies entry points, inputs, outputs, state, dependencies, and failure modes for each major subsystem. - Runtime Flow Chains: Documents function logic chains showing how data and control move through the system, not just file listings. - Secret Safety: Redacts credentials and scans the generated document for leaked API keys, tokens, and passwords before delivery. - Use Case: Point the Skill at a project root and receive a structured architecture doc with module tables, cross-system runtime flows, risks, and handoff notes saved to the project's docs directory. ## Quick Start Analyze the architecture of the project in the current directory and generate a Markdown handoff document saved under its docs folder.

Frequently Asked Questions about project-architecture-documentation

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

FAQPage Schema
How do I generate architecture documentation from an existing codebase?▼

Point the Skill at the project root and it surveys README files, configs, entrypoints, and registries, then writes a structured Markdown document covering subsystems, module tables, and runtime flows. The output is saved under the project's docs directory and verified.

What sections does the generated architecture document include?▼

The document includes an executive overview, per-subsystem sections with core positioning, functions, module tables, logic chains, and key mechanisms, plus cross-system runtime flows, handoff notes, risks, and a conclusion.

Does the architecture documentation include API keys or secrets from config files?▼

No. The Skill never copies API keys, tokens, passwords, or connection strings into the document, replacing them with [REDACTED] when needed. It also scans the finished document for secret patterns before delivery.

When should I not use codebase architecture documentation generation?▼

Avoid it for pure line-of-code or language statistics, which belong to codebase inspection, and for future implementation plans, which belong to planning workflows. It targets explaining existing systems, not designing new ones.

Can the architecture document follow a custom structure or framework?▼

Yes. If you name specific layers, architectures, or required sections, the Skill structures the document around them instead of its default template. It records your required sections during the initial scoping step.

Related Skills

Explore More Software Engineering Skills→
nguyenpv1980-wqnguyenpv1980-wq
2

agent-startup-context-gate

Verify repository identity and read governing instructions before coding tasks.

Community
Advanced
42team-ru42team-ru

shape

Plan UX/UI by interviewing stakeholders and generating a structured design brief.

Official
Advanced
kaminocorpkaminocorp
1

codebase-inspection

Inspect repositories with pygount to count lines of code and analyze language composition.

Official
Basic
jay-steenbergenjay-steenbergen
2

whiteboard

Guides learners to sketch Mermaid architecture diagrams before writing any code.

Community
Intermediate