Cursor rule

1---
2alwaysApply: false
3---
4 
5# Reverse Engineering
6 
7**Purpose**: Analyze existing codebase and generate comprehensive design artifacts
8 
9**Execute when**: Brownfield project detected (existing code found in workspace)
10 
11**Skip when**: Greenfield project (no existing code)
12 
13**Rerun behavior**: Rerun is controlled by workspace-detection.md. If existing reverse engineering artifacts are found and are still current, they are loaded and reverse engineering is skipped. If artifacts are stale (older than the codebase's last significant modification) or the user explicitly requests a rerun, reverse engineering executes again to ensure artifacts reflect current code state
14 
15## Step 1: Multi-Package Discovery
16 
17### 1.1 Scan Workspace
18- All packages (not just mentioned ones)
19- Package relationships via config files
20- Package types: Application, CDK/Infrastructure, Models, Clients, Tests
21 
22### 1.2 Understand the Business Context
23- The core business that the system is implementing overall
24- The business overview of every package
25- List of Business Transactions that are implemented in the system
26 
27### 1.3 Infrastructure Discovery
28- CDK packages (package.json with CDK dependencies)
29- Terraform (.tf files)
30- CloudFormation (.yaml/.json templates)
31- Deployment scripts
32 
33### 1.4 Build System Discovery
34- Build systems: Brazil, Maven, Gradle, npm
35- Config files for build-system declarations
36- Build dependencies between packages
37 
38### 1.5 Service Architecture Discovery
39- Lambda functions (handlers, triggers)
40- Container services (Docker/ECS configs)
41- API definitions (Smithy models, OpenAPI specs)
42- Data stores (DynamoDB, S3, etc.)
43 
44### 1.6 Code Quality Analysis
45- Programming languages and frameworks
46- Test coverage indicators
47- Linting configurations
48- CI/CD pipelines
49 
50## Step 2: Generate Business Overview Documentation
51 
52Create `aidlc-docs/inception/reverse-engineering/business-overview.md`:
53 
54```markdown
55# Business Overview
56 
57## Business Context Diagram
58[Mermaid diagram showing the Business Context]
59 
60## Business Description
61- **Business Description**: [Overall Business description of what the system does]
62- **Business Transactions**: [List of Business Transactions that the system implements and their descriptions]
63- **Business Dictionary**: [Business dictionary terms that the system follows and their meaning]
64 
65## Component Level Business Descriptions
66### [Package/Component Name]
67- **Purpose**: [What it does from the business perspective]
68- **Responsibilities**: [Key responsibilities]
69```
70 
71## Step 3: Generate Architecture Documentation
72 
73Create `aidlc-docs/inception/reverse-engineering/architecture.md`:
74 
75```markdown
76# System Architecture
77 
78## System Overview
79[High-level description of the system]
80 
81## Architecture Diagram
82[Mermaid diagram showing all packages, services, data stores, relationships]
83 
84## Component Descriptions
85### [Package/Component Name]
86- **Purpose**: [What it does]
87- **Responsibilities**: [Key responsibilities]
88- **Dependencies**: [What it depends on]
89- **Type**: [Application/Infrastructure/Model/Client/Test]
90 
91## Data Flow
92[Mermaid sequence diagram of key workflows]
93 
94## Integration Points
95- **External APIs**: [List with purposes]
96- **Databases**: [List with purposes]
97- **Third-party Services**: [List with purposes]
98 
99## Infrastructure Components
100- **CDK Stacks**: [List with purposes]
101- **Deployment Model**: [Description]
102- **Networking**: [VPC, subnets, security groups]
103```
104 
105## Step 4: Generate Code Structure Documentation
106 
107Create `aidlc-docs/inception/reverse-engineering/code-structure.md`:
108 
109```markdown
110# Code Structure
111 
112## Build System
113- **Type**: [Maven/Gradle/npm/Brazil]
114- **Configuration**: [Key build files and settings]
115 
116## Key Classes/Modules
117[Mermaid class diagram or module hierarchy]
118 
119### Existing Files Inventory
120[List all source files with their purposes - these are candidates for modification in brownfield projects]
121 
122**Example format**:
123- `[path/to/file]` - [Purpose/responsibility]
124 
125## Design Patterns
126### [Pattern Name]
127- **Location**: [Where used]
128- **Purpose**: [Why used]
129- **Implementation**: [How implemented]
130 
131## Critical Dependencies
132### [Dependency Name]
133- **Version**: [Version number]
134- **Usage**: [How and where used]
135- **Purpose**: [Why needed]
136```
137 
138## Step 5: Generate API Documentation
139 
140Create `aidlc-docs/inception/reverse-engineering/api-documentation.md`:
141 
142```markdown
143# API Documentation
144 
145## REST APIs
146### [Endpoint Name]
147- **Method**: [GET/POST/PUT/DELETE]
148- **Path**: [/api/path]
149- **Purpose**: [What it does]
150- **Request**: [Request format]
151- **Response**: [Response format]
152 
153## Internal APIs
154### [Interface/Class Name]
155- **Methods**: [List with signatures]
156- **Parameters**: [Parameter descriptions]
157- **Return Types**: [Return type descriptions]
158 
159## Data Models
160### [Model Name]
161- **Fields**: [Field descriptions]
162- **Relationships**: [Related models]
163- **Validation**: [Validation rules]
164```
165 
166## Step 6: Generate Component Inventory
167 
168Create `aidlc-docs/inception/reverse-engineering/component-inventory.md`:
169 
170```markdown
171# Component Inventory
172 
173## Application Packages
174- [Package name] - [Purpose]
175 
176## Infrastructure Packages
177- [Package name] - [CDK/Terraform] - [Purpose]
178 
179## Shared Packages
180- [Package name] - [Models/Utilities/Clients] - [Purpose]
181 
182## Test Packages
183- [Package name] - [Integration/Load/Unit] - [Purpose]
184 
185## Total Count
186- **Total Packages**: [Number]
187- **Application**: [Number]
188- **Infrastructure**: [Number]
189- **Shared**: [Number]
190- **Test**: [Number]
191```
192 
193## Step 7: Generate Technology Stack Documentation
194 
195Create `aidlc-docs/inception/reverse-engineering/technology-stack.md`:
196 
197```markdown
198# Technology Stack
199 
200## Programming Languages
201- [Language] - [Version] - [Usage]
202 
203## Frameworks
204- [Framework] - [Version] - [Purpose]
205 
206## Infrastructure
207- [Service] - [Purpose]
208 
209## Build Tools
210- [Tool] - [Version] - [Purpose]
211 
212## Testing Tools
213- [Tool] - [Version] - [Purpose]
214```
215 
216## Step 8: Generate Dependencies Documentation
217 
218Create `aidlc-docs/inception/reverse-engineering/dependencies.md`:
219 
220```markdown
221# Dependencies
222 
223## Internal Dependencies
224[Mermaid diagram showing package dependencies]
225 
226### [Package A] depends on [Package B]
227- **Type**: [Compile/Runtime/Test]
228- **Reason**: [Why dependency exists]
229 
230## External Dependencies
231### [Dependency Name]
232- **Version**: [Version]
233- **Purpose**: [Why used]
234- **License**: [License type]
235```
236 
237## Step 9: Generate Code Quality Assessment
238 
239Create `aidlc-docs/inception/reverse-engineering/code-quality-assessment.md`:
240 
241```markdown
242# Code Quality Assessment
243 
244## Test Coverage
245- **Overall**: [Percentage or Good/Fair/Poor/None]
246- **Unit Tests**: [Status]
247- **Integration Tests**: [Status]
248 
249## Code Quality Indicators
250- **Linting**: [Configured/Not configured]
251- **Code Style**: [Consistent/Inconsistent]
252- **Documentation**: [Good/Fair/Poor]
253 
254## Technical Debt
255- [Issue description and location]
256 
257## Patterns and Anti-patterns
258- **Good Patterns**: [List]
259- **Anti-patterns**: [List with locations]
260```
261 
262## Step 10: Create Timestamp File
263 
264Create `aidlc-docs/inception/reverse-engineering/reverse-engineering-timestamp.md`:
265 
266```markdown
267# Reverse Engineering Metadata
268 
269**Analysis Date**: [ISO timestamp]
270**Analyzer**: AI-DLC
271**Workspace**: [Workspace path]
272**Total Files Analyzed**: [Number]
273 
274## Artifacts Generated
275- [x] architecture.md
276- [x] code-structure.md
277- [x] api-documentation.md
278- [x] component-inventory.md
279- [x] technology-stack.md
280- [x] dependencies.md
281- [x] code-quality-assessment.md
282```
283 
284## Step 11: Update State Tracking
285 
286Update `aidlc-docs/aidlc-state.md`:
287 
288```markdown
289## Reverse Engineering Status
290- [x] Reverse Engineering - Completed on [timestamp]
291- **Artifacts Location**: aidlc-docs/inception/reverse-engineering/
292```
293 
294## Step 12: Present Completion Message to User
295 
296```markdown
297# 🔍 Reverse Engineering Complete
298 
299[AI-generated summary of key findings from analysis in the form of bullet points]
300 
301> **📋 <u>**REVIEW REQUIRED:**</u>**  
302> Please examine the reverse engineering artifacts at: `aidlc-docs/inception/reverse-engineering/`
303 
304> **🚀 <u>**WHAT'S NEXT?**</u>**
305>
306> **You may:**
307>
308> 🔧 **Request Changes** - Ask for modifications to the reverse engineering analysis if required
309> ✅ **Approve & Continue** - Approve analysis and proceed to **Requirements Analysis**
310```
311 
312## Step 13: Wait for User Approval
313 
314- **MANDATORY**: Do not proceed until user explicitly approves
315- **MANDATORY**: Log user's response in audit.md with complete raw input
316