搜索

PythonReactSEOPDF
GitHub Skill

lld

Low Level Design (LLD) document creation with detailed implementation specifications

actualyze-ai☆ 4 仓库 Stars2 仓库 Forks

安装与使用

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

查看来源 ↗使用指南

技能说明

Amazon Low Level Design (LLD) Skill

Use this skill when creating detailed technical specifications for software components. LLD documents bridge the gap between high-level architecture and actual code implementation, providing engineers with everything they need to build.

Template: See docs/templates/lld-template.md for the authoritative template structure.

When to Use This Skill

  • After HLD is approved and detailed implementation specs are needed
  • When engineers need complete API specs, database schemas, and sequence diagrams
  • When defining component interfaces and data flows
  • When creating specifications detailed enough for immediate implementation

Document Structure Summary

Create a ~6-page document (3000-3500 words) with these sections:

  1. Title & Metadata - Component/service name, author, date, version, related HLD
  2. Introduction (½ page) - Context, scope, audience, terminology
  3. Detailed Component Design (2-3 pages) - Responsibilities, dependencies, interfaces, data flow, error handling, configuration
  4. Data Models & Schemas (1-1.5 pages) - Entity definitions, database schemas, indexing strategy, serialization
  5. API Specifications (1 page) - Complete endpoints with request/response examples, error codes, validation
  6. Sequence & State Diagrams (½ page) - Key flows, state machines
  7. Operational Considerations (½ page) - Monitoring metrics, logging, performance targets, deployment
  8. Open Issues/Assumptions (½ page) - Issues, assumptions, prototyping needs

Writing Style

Aspect Guideline
Language Clear, fact-driven narrative; technical precision for specs
Tense Present tense, as if design exists
Customer Focus Connect technical decisions to customer value
Examples Include concrete examples (JSON, SQL, API calls)
Tradeoffs Document rationale for design choices

Quality Checklist

  • All components have clear responsibilities and boundaries
  • Data flows are explicitly documented with state transitions
  • APIs include complete request/response specifications
  • Database schemas include proper indexing strategies
  • Mermaid diagrams accurately represent system flows
  • Error handling covers all failure scenarios
  • Performance and monitoring requirements are specified
  • Word count: 3000-3500 words

Output Location

docs/design/[component-name]-lld.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!