technical-blueprint

Solid

Write a Technical Design Document (TDD) / Software Design Document (SDD) that details how a specific feature or component will be built. Covers problem statement, proposed design, data model, API contracts, alternatives considered, security threat analysis, test plan, and rollback plan. Use when an engineer or team needs to align on the implementation approach before writing code.

AI & Automation 6 stars 2 forks Updated 6 days ago MIT

Install

View on GitHub

Quality Score: 84/100

Stars 20%
28
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

## Purpose Produce a Technical Design Document (TDD) that captures the engineering design of a specific feature or component with enough detail that any qualified engineer on the team can implement it correctly. This document is a **thinking tool first, an artifact second** - the process of writing it surfaces gaps before they become production bugs. Unlike an architecture document (what the system is), a blueprint specifies **how a specific piece will be built**. ## Input **Works best with:** The name of the feature, component, or change to be designed. **Also valuable:** The technical specification or requirements document, existing codebase context, known constraints (performance targets, security requirements, API contracts that must be maintained). **Example invocation:** `Write a technical design document for adding TOTP-based two-factor authentication to the admin login flow. We use PHP 8.3, PDO/MySQL, and Twig templates. The TOTP secret must be stored encrypted. Recovery codes must be supported.` ## Key Concepts ### Design Doc Philosophy (Google/Stripe Standard) A design doc is: - **Short as possible, long as necessary.** If it takes more than 45 minutes to read, it is too long. - **Trade-off focused.** The Alternatives Considered section is mandatory. It proves you evaluated options. - **A conversation starter.** Share early and revise often. A design doc is not a contract. - **Living.** Update it as the implementation evolves. Stale design docs are worse than...

Details

Author
fattain-naime
Repository
fattain-naime/engineering-docs
Created
2 months ago
Last Updated
6 days ago
Language
JavaScript
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category

Data & Documents Listed

create-technical-design-document

Use to turn product and system understanding into a technical design document - context, detailed design per component, data and API design, cross-cutting concerns, environments (preview/development/production), alternatives considered, and ADR candidates.

0 Updated 4 days ago
johnoconnor0
Web & Frontend Listed

design-doc

Collaboratively drafts a Technical Design Document (TDD) as a Staff-level engineering thought partner, through a paced back-and-forth rather than a single generated document. Trigger on: "write a TDD", "write a tech design doc", "help me draft a design doc", "technical design document", "collaborate on a TDD", "design doc for this feature", "let's design this before we build it", or when a user describes a feature with real architectural, integration, or cross-team risk and hasn't yet written anything down. Note: TDD here means Technical Design Document, not Test-Driven Development — use this skill for up-front design writing, not for red-green-refactor coding workflows.

1 Updated yesterday
tkolleh
Web & Frontend Listed

tech-design-generation

Generates professional Technical Design Documents following industry-standard engineering practices. This skill activates when the user asks to write a technical design, create an architecture design, draft a design doc, write a technical proposal, do system design, create a technical design document, write an RFC, create a design document, or produce an architecture document. It synthesizes best practices from the Google Design Doc format, the RFC template structure, and Uber/Meta engineering design standards to produce comprehensive, implementable technical designs tailored to the user's project and codebase.

7 Updated 1 months ago
tercel