lets-document

Community

Automate system documentation with code and human insights.

Authorwilliamzelesny
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill automates the creation of in-repo documentation for software systems, ensuring that architectural, functional, and business process details are maintained and easily accessible for team members and contributors.

Core Features & Use Cases

  • Automated Documentation: Generates markdown files detailing system architecture, functionality, and business processes.
  • Code-Driven: Uses the codebase as a source of truth for structure, with human insights providing context and rationale.
  • Interview-Based: Conducts targeted interviews to capture details not directly available in the code.
  • In-Repo: Maintains all documentation within the repository for easy access and version control.

Quick Start

Run /lets-document <topic> to document a specific subsystem or feature, or omit <topic> to generate a survey of the entire application.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: lets-document
Download link: https://github.com/williamzelesny/lets-engineer/archive/main.zip#lets-document

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 620,000+ vetted skills library on demand.