more detailed SDLC plan

This commit is contained in:
Oleksandr Bezdieniezhnykh
2025-12-10 19:05:17 +02:00
parent 73cbe43397
commit fd75243a84
22 changed files with 2087 additions and 34 deletions
+71 -2
View File
@@ -2,6 +2,12 @@
This tutorial guides through analyzing, documenting, and refactoring an existing codebase.
## Reference Documents
- Definition of Done: `@_docs/00_templates/definition_of_done.md`
- Quality Gates: `@_docs/00_templates/quality_gates.md`
- Feature Parity Checklist: `@_docs/00_templates/feature_parity_checklist.md`
- Baseline Metrics: `@_docs/04_refactoring/baseline_metrics.md` (created in 4.07)
## 4.05 **🧑‍💻 Developers**: User Input
@@ -12,6 +18,24 @@ This tutorial guides through analyzing, documenting, and refactoring an existing
- `security_approach.md`: Security requirements (if applicable)
## 4.07 **🤖📋AI plan**: Capture Baseline Metrics
### Execute `/4.refactoring/4.07_capture_baseline`
### Revise
- Verify all metrics are captured accurately
- Document measurement methodology
- Save raw data for later comparison
### Store
- Create folder `_docs/04_refactoring/`
- Save output to `_docs/04_refactoring/baseline_metrics.md`
### Create Feature Parity Checklist
- Copy `@_docs/00_templates/feature_parity_checklist.md` to `_docs/04_refactoring/`
- Fill in current feature inventory
## 4.10 **🤖📋AI plan**: Build Documentation from Code
### Execute `/4.refactoring/4.10_documentation`
@@ -53,6 +77,15 @@ This tutorial guides through analyzing, documenting, and refactoring an existing
### Execute `/4.refactoring/4.40_tests_description`
### Prerequisites Check
- Baseline metrics captured (4.07)
- Feature parity checklist created
### Coverage Requirements
- Minimum overall coverage: 75%
- Critical path coverage: 90%
- All public APIs must have integration tests
### Revise
- Ensure tests cover critical functionality
- Add edge cases
@@ -65,6 +98,10 @@ This tutorial guides through analyzing, documenting, and refactoring an existing
### Verify
- All tests pass on current codebase
- Tests serve as safety net for refactoring
- Coverage meets requirements (75% minimum)
### Quality Gate: Safety Net Ready
Review `@_docs/00_templates/quality_gates.md` - Refactoring Gate 1
## 4.60 **🤖📋AI plan**: Analyze Coupling
@@ -80,9 +117,13 @@ This tutorial guides through analyzing, documenting, and refactoring an existing
### Execute `/4.refactoring/4.70_execute_decoupling`
### Verify
### Verify After Each Change
- Run integration tests after each change
- All tests must pass before proceeding
- Update feature parity checklist
### Quality Gate: Refactoring Safe
Review `@_docs/00_templates/quality_gates.md` - Refactoring Gate 2
## 4.80 **🤖📋AI plan**: Technical Debt
@@ -99,7 +140,8 @@ This tutorial guides through analyzing, documenting, and refactoring an existing
### Execute `/4.refactoring/4.90_performance`
### Verify
- Benchmark before/after
- Compare against baseline metrics from 4.07
- Performance should be improved or maintained
- Run tests to ensure no regressions
@@ -111,3 +153,30 @@ This tutorial guides through analyzing, documenting, and refactoring an existing
- Address identified vulnerabilities
- Run security tests if applicable
## 4.97 **🧑‍💻 Developer**: Final Verification
### Quality Gate: Refactoring Complete
Review `@_docs/00_templates/quality_gates.md` - Refactoring Gate 3
### Compare Against Baseline
- [ ] Code coverage >= baseline
- [ ] Performance metrics improved or maintained
- [ ] All features preserved (feature parity checklist complete)
- [ ] Technical debt reduced
### Feature Parity Verification
- [ ] All items in feature parity checklist verified
- [ ] No functionality lost
- [ ] All tests pass
### Documentation
- [ ] Update solution.md with changes
- [ ] Document any intentional behavior changes
- [ ] Update README if needed
### Commit
```bash
git add .
git commit -m "Refactoring: complete"
```