Skip to content

CLAUDE.md

Latest commit

 

History

History
89 lines (68 loc) · 4.28 KB

CLAUDE.md

File metadata and controls

89 lines (68 loc) · 4.28 KB
Raw

CLAUDE.md — system-design Skill (Folder 3)

Skill Identity

  • Name: system-design
  • Tagline: Research-first software architecture harness — from vague requirement to production-grade design doc
  • Current Phase: Phase 0 — Architecture Complete, Build Ready
  • Folder: D:\Dungchan\3\

Problem This Skill Solves

Software engineers and architects routinely face the challenge of translating ambiguous feature requests or project briefs into coherent, defensible system designs. The process typically requires: clarifying requirements with stakeholders, researching how similar systems are built at scale, making architectural trade-offs explicit, modeling data and APIs, planning for capacity and non-functional requirements, and producing artifacts (HLD, LLD, ADRs) that teams can actually build from.

This skill replaces an ad-hoc, memory-based design session with a structured, research-first harness that challenges assumptions at every stage and produces professional-grade deliverables — High Level Design, Low Level Design, Database Schema, API Contract, Architecture Decision Records, and Capacity Plan.

Harness Flow Summary

/system-design
  Stage 1 → sub-gather-requirements   : Elicit, clarify, and formalize requirements
  Stage 2 → sub-research-similar-cases: Research real-world analogues and best practices
  Stage 3 → [inline] Architecture     : Select patterns, define components, draw boundaries
  Stage 4 → sub-capacity-planning     : NFR analysis, load estimates, capacity sizing
  Stage 5 → [inline] DB & API Design  : Data model, schema, API contracts
  Stage 6 → sub-adr-writer            : Document all major architectural decisions
  Stage 7 → sub-document-writer       : Assemble final deliverable (HLD + LLD + all artifacts)
  Stage 8 → [inline] Quality Gate     : Self-review against professional architecture standards

Sub-Skills

File Purpose
skills/sub-gather-requirements.md Structured requirements elicitation; pushes back on ambiguity; produces formal requirement spec
skills/sub-research-similar-cases.md Finds real-world system analogues; extracts architectural patterns and lessons learned
skills/sub-capacity-planning.md NFR analysis, QPS/DAU/data volume estimation, capacity sizing, SLA definition
skills/sub-adr-writer.md Writes Architecture Decision Records for every major trade-off
skills/sub-document-writer.md Assembles HLD + LLD + DB schema + API contract into a single professional document

Tools Required

  • WebSearch — research similar system designs, industry patterns, benchmarks
  • WebFetch — retrieve specific engineering blogs, architecture case studies, RFC documents
  • Read — load SECOND-KNOWLEDGE-BRAIN.md and reference documents
  • Write — produce all output files
  • Bash — optional: generate PlantUML or Mermaid diagrams, validate JSON schemas

Knowledge Sources (for crawl pipeline)

  • Blogs: engineering.atspotify.com, netflixtechblog.com, engineering.fb.com, eng.uber.com, aws.amazon.com/blogs/architecture, cloud.google.com/blog/topics/developers-practitioners, medium.com/airbnb-engineering
  • Papers: ArXiv cs.DC (Distributed Computing), cs.SE (Software Engineering), ACM Digital Library
  • Databases: system-design-primer (GitHub), awesome-system-design (GitHub)
  • RFCs/Standards: IETF RFCs, OpenAPI Specification, gRPC documentation

Supporting Python Tools

  • tools/knowledge_updater.py — crawl4ai pipeline that fetches latest engineering blog posts and papers; appends to SECOND-KNOWLEDGE-BRAIN.md

Active Development Tasks

  • Write CLAUDE.md
  • Write PROJECT-detail.md
  • Write PROJECT-DEVELOPMENT-PHASE-TRACKING.md
  • Write SECOND-KNOWLEDGE-BRAIN.md
  • Write skills/main.md
  • Write skills/sub-gather-requirements.md
  • Write skills/sub-research-similar-cases.md
  • Write skills/sub-capacity-planning.md
  • Write skills/sub-adr-writer.md
  • Write skills/sub-document-writer.md
  • Write tools/knowledge_updater.py
  • Write tests/test-scenarios.md

References

  • Full spec: PROJECT-detail.md
  • Build roadmap: PROJECT-DEVELOPMENT-PHASE-TRACKING.md
  • Domain knowledge base: SECOND-KNOWLEDGE-BRAIN.md
  • Root library spec: D:\Dungchan\CLAUDE.md