Design Documentation

What it does

This skill assists in creating technical design documentation, bridging the gap between requirements and implementation. It guides users through documenting architecture decisions, component designs, and system interactions, providing a structured approach to planning technical work. The skill emphasizes understanding requirements, researching options, defining architecture, designing components, and outlining data models and testing strategies.

When to use it

• After requirements are complete and approved.
• When planning the technical implementation of a feature.
• When multiple developers will be working on a single feature.
• To document important architectural decisions.
• For features involving complex integrations.

Key capabilities

• Provides a standard template for design documents, including sections for Overview, Architecture, Components and Interfaces, Data Models, Error Handling, and Testing Strategy.
• Guides users through a step-by-step process: Requirements Analysis, Research & Context Building, Defining System Architecture, Designing Components and Interfaces, and defining Data Models.
• Includes guidance on analyzing requirements (functional, non-functional, constraints, integration points).
• Facilitates research documentation with sections for Sources, Key Insights, and Impact on Design.
• Supports documenting architecture diagrams using Mermaid syntax.

Example prompts

• "Create a design document outline for the new user authentication feature."
• "Help me define the architecture of the payment processing system."
• "What are some key considerations when designing components for a microservice?"

Tips & gotchas

• Ensure all functional and non-functional requirements are understood before beginning the design process.
• The skill provides a template; adapt it to fit the specific needs of your project.
• Consider security and compliance implications during both the research and design phases.