Agent skill
doc-design
Generate a Design Document from template. Use when the user says "write a design doc", "technical design", "system design", or "architecture document for this feature".
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/other/other/doc-design
SKILL.md
Generate Design Document
Path Resolution
- Read
workflow.jsonin the project root - If it exists and
docsRepois".": this IS the docs repo — use local paths - If it exists and
docsRepois a repo name: resolve viapwsh .claude/skills/tool-worktree/scripts/resolve-repo.ps1 <docsRepo>to get the docs root path. Templates at<resolved>/templates/, output to<resolved>/design/ - If no
workflow.json: templates attemplates/, output todocs/design/
Instructions
- Resolve paths (see Path Resolution above)
- Read the template at
<templates>/design-doc.md - Gather context:
- Read relevant source code to understand the current architecture
- Check for existing PRDs, RFCs, or ADRs related to this feature
- Understand the tech stack and patterns in use
- Generate the design doc with emphasis on:
- Architecture: Include Mermaid C4 diagrams (use
templates/c4-diagrams.mdfor syntax) - Component Design: Detail each component's responsibility and interface
- Data Design: Schema changes, data flow
- Cross-cutting concerns: Security, observability, scalability, reliability
- Test Plan: Concrete testing strategy
- Architecture: Include Mermaid C4 diagrams (use
- Save to
<output>/[slug].md
Quality Checklist
- Overview is understandable by someone outside the team
- Goals and non-goals are explicit
- Architecture includes at least a C4 Context or Container diagram
- Alternatives section has genuine options (not just "do nothing")
- Cross-cutting concerns are addressed (security, observability, scalability)
- Test plan covers unit, integration, and e2e
- Implementation plan has phased delivery
Tips
- A design doc is the blueprint — it should be detailed enough that someone else could implement it
- Include C4 diagrams at the appropriate level (Context for new systems, Component for features)
- Link to the PRD for requirements and to ADRs for past decisions
- Call out risks and unknowns explicitly
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?