搜索

PythonReactSEOPDF
GitHub Skill

hld

High Level Design (HLD) document creation for engineering design reviews

actualyze-ai☆ 4 仓库 Stars2 仓库 Forks

安装与使用

请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。

查看来源 ↗使用指南

技能说明

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:

  1. Title & Metadata - System name, author, date, version, status
  2. Overview (1 page) - Executive summary, problem statement, goals, non-goals, success metrics
  3. Tenets/Principles (½ page) - 4-6 design principles with examples
  4. Architecture (2-2.5 pages) - System diagram, component responsibilities, data flow, API design, scale/performance, security
  5. Detailed Design Considerations (1-1.5 pages) - Alternatives considered, failure modes, operational concerns (monitoring, deployment, cost)
  6. Risks & Open Questions (½ page) - Dependencies, open questions, assumptions
  7. 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

使用示例

查看来源仓库中的使用示例与配置说明。

查看来源 ↗

来源历史

收录时间
2026-01-20
索引更新时间
2026-01-30
Branch
main

收录与同步日期属于本站记录。源码修改历史请查看来源仓库。

GitHub ↗

chat Comments (0)

chat_bubble_outline

No comments yet. Be the first to share your thoughts!