reverse-spec-writer
CommunityDocument existing code automatically.
Software Engineering#architecture#code analysis#documentation#microservices#spec generation#reverse engineering
Authorsaddam-eng-tech
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill addresses the challenge of understanding and documenting existing codebases, especially when original documentation is missing or outdated, saving significant time and effort in onboarding and maintenance.
Core Features & Use Cases
- Codebase Analysis: Scans project structure, entry points, and configuration files.
- Architecture Mapping: Identifies and documents system layers, dependencies, and external services.
- Data Model Extraction: Extracts and documents domain entities, including fields, types, and relationships.
- API Contract Documentation: Documents exposed endpoints or RPC methods, including request/response shapes and authentication.
- Behavioral Documentation: Extracts key business rules and system behaviors.
- Use Case: You inherit a legacy Go microservice with no documentation. This Skill can generate a
spec.mddetailing its architecture, data models, and API endpoints, allowing you to quickly understand and contribute to the project.
Quick Start
Use the reverse-spec-writer skill to generate a spec.md for the current project directory.
Dependency Matrix
Required Modules
None requiredComponents
scripts
💻 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: reverse-spec-writer Download link: https://github.com/saddam-eng-tech/ai-agent-skills/archive/main.zip#reverse-spec-writer Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.