Back to Guides
A short AI-narrated film with English captions. Pressing play loads the YouTube player. Watch on YouTube
Guide Origin: Official | ArcKit Version: [VERSION]
/arckit:dld-review reviews a Detailed-Level Design (DLD) for implementation readiness, technical accuracy, and alignment with HLD.
Inputs
| Artefact | Purpose |
|---|---|
| Detailed-Level Design (DLD) | The design document being reviewed |
| High-Level Design (HLD) | Reference for architectural alignment |
Requirements (ARC-<id>-REQ-v1.0.md) |
Verify all requirements addressed |
| Architecture principles | Governance standards to verify |
Command
/arckit:dld-review Review DLD for <component/service>
Output: projects/<id>/reviews/ARC-<id>-DLDR-v1.0.md
Review Structure
| Section | Contents |
|---|---|
| Review Summary | Overall assessment and recommendation |
| HLD Alignment | Does the DLD correctly implement the HLD? |
| Requirements Coverage | All requirements traceable to design elements |
| Technical Accuracy | Correct use of patterns, technologies, protocols |
| Implementation Readiness | Sufficient detail for developers to build |
| Security Review | Security requirements properly addressed |
| Data Design Review | Data models, schemas, migrations |
| Integration Review | API contracts, message formats, error handling |
| Operational Readiness | Logging, monitoring, deployment considerations |
| Findings & Recommendations | Issues categorized by severity |
Review Categories
| Category | Focus | Examples |
|---|---|---|
| Correctness | Technical accuracy | Wrong protocol, invalid schema |
| Completeness | Missing detail | Undefined error handling, missing API fields |
| Consistency | HLD alignment | Deviation from approved architecture |
| Clarity | Implementation readiness | Ambiguous specifications |
| Compliance | Standards adherence | Security standards, coding guidelines |
Severity Levels
| Severity | Impact | Action Required |
|---|---|---|
| Critical | Blocks implementation | Must fix before approval |
| Major | Significant rework risk | Should fix before approval |
| Minor | Quality improvement | Fix during implementation |
| Suggestion | Enhancement | Consider for future |
One-Page Workflow
| Phase | Key Activities | ArcKit Commands |
|---|---|---|
| HLD Approval | Get HLD reviewed and approved | /arckit:hld-review |
| DLD Creation | Write detailed design | Manual |
| DLD Review | Review DLD for readiness | /arckit:dld-review |
| Approval | Address findings, get sign-off | Manual |
| Implementation | Build from approved DLD | /arckit:backlog |
Review Checklist
- DLD correctly implements HLD architecture decisions.
- All requirements have traceable design elements.
- API contracts fully specified (request/response, errors).
- Data models include schemas, constraints, migrations.
- Security controls designed per requirements.
- Error handling comprehensive (happy and sad paths).
- Logging and monitoring hooks defined.
- Deployment and rollback procedures documented.
- No critical or major findings remain open.
Key Principles
- HLD as Contract: DLD must implement the approved HLD.
- Developer Ready: Design must be sufficient to code from.
- Traceability: Every design element maps to a requirement.
- Security First: Security is designed in, not bolted on.
- Operational Awareness: Consider day-2 operations during design.