Skip to content

majiayu000/spellbook / skills/technical-spec

technical-spec

Verified

Technical specification and design document expert. Use when writing design docs, RFCs, ADRs, or evaluating technology choices. Covers C4 model, system design, and architecture documentation.

FileKindSize
SKILL.mdskill md12.9 KB
reference/adr.mdmarkdown18.0 KB
reference/c4-model.mdmarkdown23.1 KB
reference/design-doc.mdmarkdown20.0 KB
reference/extended.mdmarkdown3.9 KB
reference/tech-selection.mdmarkdown16.4 KB
templates/adr-template.mdmarkdown5.2 KB
templates/design-doc-template.mdmarkdown11.7 KB

reference/extended.md

View on GitHub
# technical-spec Extended Reference

This file preserves detailed material moved out of `SKILL.md` for progressive disclosure. Load it only when the current task needs the specific examples, commands, templates, or checklists below.

Moved content starts at: `## Quick Reference Card`.

## Quick Reference Card

```
┌─────────────────────────────────────────────────────────────┐
│           TECHNICAL DOCUMENT QUICK GUIDE                    │
├─────────────────────────────────────────────────────────────┤
│  Document Type Selection                                    │
│  ├── New feature → Technical Design Doc (TDD)               │
│  ├── Architecture → C4 Diagrams + System Design Doc         │
│  ├── Single decision → Architecture Decision Record (ADR)   │
│  ├── Cross-team proposal → Request for Comments (RFC)       │
│  └── Technology choice → Tech Evaluation Matrix             │
├─────────────────────────────────────────────────────────────┤
│  Essential Sections (TDD)                                   │
│  ├── 1. Problem Statement (Why?)                            │
│  ├── 2. Proposed Solution (What?)                           │
│  ├── 3. Alternatives Considered (Why not X?)                │
│  ├── 4. Risk Assessment (What could go wrong?)              │
│  ├── 5. Implementation Plan (How & When?)                   │
│  ├── 6. Success Metrics (How to measure?)                   │
│  └── 7. Open Questions (What's unclear?)                    │
├─────────────────────────────────────────────────────────────┤
│  Best Practices                                             │
│  ├── Write BEFORE implementation                            │
│  ├── Use diagrams for complex flows                         │
│  ├── Keep language simple and direct                        │
│  ├── Show trade-offs, not just solutions                    │
│  ├── Define success criteria                                │
│  └── Update docs as system evolves                          │
└─────────────────────────────────────────────────────────────┘
```

---

## See Also

- [reference/design-doc.md](reference/design-doc.md) — Technical design document guide
- [reference/adr.md](reference/adr.md) — Architecture Decision Records
- [reference/c4-model.md](reference/c4-model.md) — C4 architecture diagrams
- [reference/tech-selection.md](reference/tech-selection.md) — Technology evaluation matrix
- [templates/design-doc-template.md](templates/design-doc-template.md) — TDD template
- [templates/adr-template.md](templates/adr-template.md) — ADR template

---

## Sources

Research based on 2025 best practices from:
- [Technical Design Document Examples 2025](https://www.docuwriter.ai/posts/technical-design-document-examples)
- [Stack Overflow: Practical Guide to Technical Specs](https://stackoverflow.blog/2020/04/06/a-practical-guide-to-writing-technical-specs/)
- [Microsoft Learn: Functional & Technical Design](https://learn.microsoft.com/en-us/dynamics365/guidance/patterns/create-functional-technical-design-document)
- [Atlassian: Software Design Document Best Practices](https://www.atlassian.com/work-management/knowledge-sharing/documentation/software-design-document)
brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).Stars: 322kUpdated Claude CodeCodexVerifiedInstall
brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).Stars: 198kUpdated Claude CodeCodexVerifiedInstall