skills.rest
saddam-eng-tech
saddam-eng-techCOMMUNITY
Explore all skills by this author →
GitHub

reverse-spec-writer

Generate spec.md documentation from existing Go, gRPC, and microservice codebases.

Updated Jan 17, 2026
Search Tags:#architecture#code analysis#documentation#microservices#spec generation#reverse engineering
One-click install
npx skills add https://github.com/saddam-eng-tech/ai-agent-skills --skill reverse-spec-writer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: reverse-spec-writer
Source: https://github.com/saddam-eng-tech/ai-agent-skills/tree/main/reverse-spec-writer
Command: npx skills add https://github.com/saddam-eng-tech/ai-agent-skills --skill reverse-spec-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

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.md detailing 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.

Frequently Asked Questions about reverse-spec-writer

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

FAQPage Schema
How do I generate documentation for an existing Go microservice codebase?▼

To generate documentation for an existing Go microservice, you can reverse-engineer the codebase to produce a comprehensive spec.md file. This process analyzes project structure, layers, data models, and API contracts to reflect the actual implementation.

What is the best way to document gRPC API contracts and data models from source code?▼

Documenting gRPC API contracts and data models from source code involves reverse-engineering the implementation to extract domain entities, fields, and exposed endpoints. This creates a detailed design document capturing request and response shapes automatically.

Can I extract business rules and system behaviors from a legacy codebase with no documentation?▼

Yes, you can extract business rules and system behaviors from a legacy codebase lacking documentation by reverse-engineering its architecture. This identifies and documents core logic, saving significant time and effort in onboarding and maintenance.

Does reverse engineering a microservice architecture require external dependencies?▼

Reverse engineering a microservice architecture to generate a spec.md file requires no external dependencies. It runs scripts to analyze the current project directory, mapping system layers and configuration files directly from the existing implementation.

How do I map microservice architecture layers and external service dependencies?▼

To map microservice architecture layers and external service dependencies, reverse-engineer the project structure to identify entry points and configurations. This generates a comprehensive design document detailing the system's actual implementation.

Related Skills

Explore More Software Engineering Skills→
333-333-333333-333-333

go-grpc-services

Define protobuf contracts and generate Go gRPC stubs for microservices.

Community
Advanced
mk-knight23mk-knight23
1

api-tester

Generate and execute pytest suites from OpenAPI specs for REST APIs.

Community
Advanced
AIDotNetAIDotNet
84

code-review

Analyze code for bugs, security vulnerabilities, and code smells.

Official
Intermediate
penghang1223penghang1223
1

doc-generator

Extract code comments and annotations into Markdown, JSON, or OpenAPI YAML documentation.

Community
Intermediate