tech-design-doc

Technical Design Document Skill

Safety Notice

This listing is imported from skills.sh public index metadata. Review upstream SKILL.md and repository scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "tech-design-doc" with this command: npx skills add bahayonghang/my-claude-code-settings/bahayonghang-my-claude-code-settings-tech-design-doc

Technical Design Document Skill

Execution Flow

  1. Assess Complexity

Level Scope Sections Required

Small Single component, <100 LOC TL;DR, Design, Implementation

Medium Cross-component, API changes

  • Background, Solution Analysis

Large System-level, new service Full template

  1. Gather Context

Explore the codebase before writing:

  • Identify affected components using Glob and Grep for related code.

  • Read existing implementations and patterns.

  • Note dependencies and potential side effects.

  • Check for similar solutions already in the codebase.

  1. Write Document
  • Read the document template from $SKILL_DIR/references/TEMPLATE.md .

  • Write the design document following the template structure, scaled to the assessed complexity level.

  1. Verify Before Handoff

Verify the following criteria:

  • Define the problem clearly (what breaks if we do nothing?).

  • Compare options with trade-offs (do not present just one solution).

  • Document the decision rationale.

  • Add diagrams to illustrate key flows.

  • Make implementation steps concrete and actionable.

  • Identify risks and provide mitigations.

  1. Handle Feedback

Process user change requests:

  • Identify which section needs revision.

  • Update only affected sections.

  • Ensure changes don't contradict other sections.

  • Re-verify the checklist items related to changes.

  1. Output Location
  • Look for a docs/ , ai_docs/ , or design/ directory in the project.

  • Ask the user if the location is unclear.

  • Save with a descriptive filename such as design-[feature-name].md .

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

Coding

article-cover

No summary provided by upstream source.

Repository SourceNeeds Review
Coding

tech-blog

No summary provided by upstream source.

Repository SourceNeeds Review
Coding

excalidraw

No summary provided by upstream source.

Repository SourceNeeds Review
Coding

git-commit-cn

No summary provided by upstream source.

Repository SourceNeeds Review