rob
0c9fba2d07
Created production-ready design document template with 14 comprehensive sections: **Structure:** 1. Executive Summary & Context 2. Requirements (Functional & Non-Functional) 3. Options Considered (with pros/cons/cost analysis) 4. Decision & Rationale (trade-offs, assumptions, review triggers) 5. Architecture (diagrams, components, data models, API contracts) 6. Implementation Plan (phases, dependencies, resources) 7. Risks & Mitigations (threat model, compliance) 8. Testing Strategy (unit, integration, e2e, performance) 9. Monitoring & Observability (metrics, alerts, dashboards) 10. Documentation & Training 11. Rollout Plan (feature flags, staged rollout, rollback) 12. Future Enhancements & Technical Debt 13. Acceptance Criteria 14. Appendices (research, meeting notes, changelog) **Features:** - Industry-standard ADR format - Comprehensive examples throughout - SQL schema examples - API contract specifications - ASCII architecture diagrams - Risk matrices and threat models - Rollout and rollback procedures - META tokens for AI placeholder replacement This template guides teams through complete technical design documentation from problem statement to production rollout. Addresses PROGRESS.md Stage 3 requirement: "Enhanced template with ADR structure" 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> |
||
|---|---|---|
| assets | ||
| automation | ||
| config | ||
| docs | ||
| src | ||
| tests | ||
| tools | ||
| .gitignore | ||
| AGENTS.md | ||
| CLAUDE.md | ||
| GEMINI.md | ||
| README.md | ||
| VERSION | ||
| pyproject.toml | ||
README.md
CascadingDev (CDev)
CDev — short for Cascading Development — is a Git-native AI–human collaboration framework that automates documentation, discussion summaries, and code review directly within your repository.
It lets you build self-documenting projects where AI assists in generating and maintaining feature discussions, design docs, and implementation plans — all version-controlled alongside your code.
✨ Key Features
- Git-Integrated Workflow — every discussion, decision, and artifact lives in Git.
- Multi-Provider AI System — automatic fallback chains (Claude → Codex → Gemini) with intelligent model selection (fast/quality).
- Cascading Rules System — nearest
.ai-rules.ymldefines how automation behaves. - Stage-Per-Discussion Model — separate files for feature, design, implementation, testing, and review.
- Pre-commit Hook — automatically maintains summaries, diagrams, and vote tallies.
- Ramble GUI — friendly PySide6/PyQt5 dialog for capturing structured feature requests.
- Deterministic Builds — a reproducible installer bundle you can unzip and run anywhere.
🚀 Quick Start (Developers)
# 1. Create and activate a virtual environment
python3 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip wheel PySide6
# 2. Build the installer bundle
python tools/build_installer.py
# 3. Test-install into a temporary folder
python install/cascadingdev-*/setup_cascadingdev.py --target /tmp/myproject --no-ramble