code-to-spec

Featured

Reverse-engineer a SPEC document from an existing project. Analyzes code, config, tests, and structure to produce a comprehensive specification. Triggers on: code-to-spec, reverse spec, generate spec, 逆向规格, 生成规格文档, 生成设计文档, 生成设计方案, extract spec, document this project, what does this project do.

Testing & QA 235 stars 32 forks Updated 5 days ago MIT

Install

View on GitHub

Quality Score: 92/100

Stars 20%
79
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# to-spec — Reverse-Engineer Project Specification Analyze an existing codebase and produce a structured SPEC document that captures what the project does, how it's built, and what contracts it exposes. The output is a living specification that could be used to rebuild the project from scratch or onboard new contributors. --- ## When to Use - You want a comprehensive understanding of an existing project - Onboarding new team members who need a high-level overview - Documenting a project that was built without a spec - Comparing actual implementation against intended design - Preparing for a rewrite or major refactor - Auditing what a project actually does vs. what people think it does --- ## The Job 1. **Scope confirmation** — ask user what to analyze (entire repo, specific directory, or specific aspect) 2. **Deep scan** — systematically read project structure, entry points, config, tests, and core logic 3. **Synthesize** — produce a structured SPEC document 4. **Review** — present to user for feedback and iteration 5. **Save** — write final SPEC to agreed location --- ## Step 1: Scope Confirmation Before scanning, ask the user: ``` What should I analyze? A. Entire repository (recommended for small-medium projects) B. Specific directory or module: [path] C. Specific aspect only (e.g., API surface, data model, auth flow) Depth level: 1. Overview — high-level architecture + tech stack + key features (fast, ~5 min) 2. Standard — includes API contracts, data models, ...

Details

Author
smallnest
Repository
smallnest/goal-workflow
Created
3 months ago
Last Updated
5 days ago
Language
HTML
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category