hld
High Level Design (HLD) document creation for engineering design reviews
Installation
Suivez les instructions du dépôt pour votre agent. Consultez les fichiers et dépendances avant l’installation.
Voir la source ↗GuidesInstructions
Amazon High Level Design (HLD) Skill
Use this skill when creating comprehensive High Level Design documents for engineering design reviews. HLD documents provide the strategic technical vision that guides implementation while remaining accessible to stakeholders.
Template: See docs/templates/hld-template.md for the authoritative template structure.
When to Use This Skill
- When documenting new system architecture for engineering review
- When creating formal design documentation for stakeholder alignment
- When translating product requirements into technical architecture
- When preparing for design review meetings
Document Structure Summary
Create a ~6-page document (2500-3000 words) with these sections:
- Title & Metadata - System name, author, date, version, status
- Overview (1 page) - Executive summary, problem statement, goals, non-goals, success metrics
- Tenets/Principles (½ page) - 4-6 design principles with examples
- Architecture (2-2.5 pages) - System diagram, component responsibilities, data flow, API design, scale/performance, security
- Detailed Design Considerations (1-1.5 pages) - Alternatives considered, failure modes, operational concerns (monitoring, deployment, cost)
- Risks & Open Questions (½ page) - Dependencies, open questions, assumptions
- Next Steps (½ page) - Validation activities, milestones, resource requirements
Writing Style
| Aspect | Guideline |
|---|---|
| Format | Full narrative paragraphs, not bullet-point dumps |
| Tense | Present tense - describe as if implemented |
| Audience | Intelligent VP who needs to understand quickly |
| Jargon | Define technical terms when first used |
| Examples | Use concrete examples to illustrate abstract concepts |
| Customer | Every section connects back to customer value |
Quality Checklist
- Customer problem clearly articulated
- Tenets are actionable and referenced in decisions
- Architecture diagram accurately represents system (Mermaid)
- All alternatives documented with rationale
- Failure modes and mitigations addressed
- Dependencies and risks explicitly stated
- Next steps are concrete and assigned
- Word count: 2500-3000 words
Output Location
docs/design/[system-name]-hld.md
Exemples
Consultez les exemples du dépôt source.
Voir la source ↗Historique source
- Date d’indexation
- 2026-01-20
- Mise à jour de l’index
- 2026-01-30
- Branch
- main
Les dates concernent ce répertoire. Consultez le dépôt pour l’historique du code.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!