skills.rest
zkzupup
zkzupupCOMMUNITY
Explore all skills by this author →
GitHub

codebase-documentation

Generate four-level module analysis documents with MasterIndex updates and diagrams.

Updated Mar 25, 2026
Search Tags:#generate#architecture-docs#module-analysis#trace-inventory#masterindex#evidence-packet
One-click install
npx skills add https://github.com/zkzupup/MySkills --skill codebase-documentation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: codebase-documentation
Source: https://github.com/zkzupup/MySkills/tree/main/skills/codebase-documentation
Command: npx skills add https://github.com/zkzupup/MySkills --skill codebase-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a disciplined approach to generating per-module documentation by orchestrating context, traces, diagrams, and MasterIndex updates to replace the need to read source code directly.

Core Features & Use Cases

  • Build a Module Context Packet and Coverage Ledger before drafting prose
  • Produce four-level depth documents (L0 concepts, L1 architecture, L2 mechanism, L3 reference)
  • Enforce diagram generation and MasterIndex integration for multi-document modules

Quick Start

Invoke this skill against a target module to generate a complete, four-level depth analysis document and update MasterIndex accordingly.

Frequently Asked Questions about codebase-documentation

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

FAQPage Schema
How do I automate software architecture documentation for complex modules?▼

Automate software architecture documentation by orchestrating MasterIndex-driven inventory and codebase structure, generating complete module analysis documents with L0-L3 depth and diagrams.

What is the best way to generate multi-depth module analysis without reading source code directly?▼

Generate multi-depth module analysis by building a Module Context Packet and Coverage Ledger, replacing the need to read source code directly through rigorous evidence collection and structured document drafting.

How do I produce four-level depth technical documents for a subsystem?▼

Produce four-level depth technical documents by drafting L0 concepts, L1 architecture, L2 mechanism, and L3 reference content, ensuring coverage closure across the target subsystem.

Can I enforce diagram generation and MasterIndex updates for multi-document codebase analysis?▼

Yes, multi-document codebase analysis enforces diagram generation and MasterIndex integration, ensuring all subsystem documentation updates are tracked and cross-referenced automatically.

Does generating module documentation require external dependencies or environment setup?▼

No, generating module documentation requires no external dependencies, allowing you to directly invoke the skill against a target module to build context packets and update the MasterIndex.

Related Skills

Explore More Software Engineering Skills→
telum-aitelum-ai
2

project-import

Create a Speck project structure with a skeleton project.md file.

Official
Basic
cosmicstack-labscosmicstack-labs
364

knowledge-base

Turn scattered internal documentation into a structured, searchable wiki.

Official
Intermediate
danielbaustindanielbaustin
4

architecture-diagram-reviewer

Generates a deterministic scaffold for validating architecture diagram packets against source evidence.

Community
Advanced
windyskywindysky

moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced