detailed-design-parser
Parses detailed-design.md files to extract and format file-specific changes for easier copying. Use this skill when the user wants to generate a `detailed-design-by-file.md` from a `detailed-design.md` file.
When & Why to Use This Skill
The Detailed Design Parser is a specialized utility designed to automate the extraction of file-specific code changes from comprehensive design documents. By transforming complex `detailed-design.md` files into organized `detailed-design-by-file.md` outputs, it streamlines the transition from architectural planning to actual implementation, making it significantly easier for developers to copy and apply changes across their codebase accurately.
Use Cases
- Scenario 1: Converting monolithic design specifications into file-specific implementation guides for easier coding.
- Scenario 2: Extracting precise code snippets from architectural documents to be pasted into IDEs or external development tools.
- Scenario 3: Automating the generation of implementation checklists by isolating changes required for each specific file in a project.
| name | detailed-design-parser |
|---|---|
| description | Parses detailed-design.md files to extract and format file-specific changes for easier copying. Use this skill when the user wants to generate a `detailed-design-by-file.md` from a `detailed-design.md` file. |
| short-description | Parse detailed-design.md for file changes |
Detailed Design Parser
This skill helps in parsing detailed-design.md files to extract code changes and format them into a detailed-design-by-file.md file. This is useful for copying file contents to other applications.
Usage
- Identify the
detailed-design.mdfile path. It is usually located atopenspec/changes/<openspec_id>/detailed-design.md. - Run the
parse_design.pyscript with the path to thedetailed-design.mdfile.
Script
The script scripts/parse_design.py takes the input file path as an argument and generates the output file in the same directory.
python {path}/scripts/parse_design.py <path_to_detailed_design_md>