bahayonghang/tech-design-doc
content/skills/document-skills/tech-design-doc/SKILL.md
Generate technical design documents with proper structure, diagrams, and implementation details. Use when designing a new feature, documenting architecture decisions, or planning refactoring work. Default language is English.
$ install --global
skillsauthnpx skillsauth add bahayonghang/my-claude-code-settings tech-design-docInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 3, 2026, 7:25 PM4.4s2 files scanned
SKILL.md
- name:
- tech-design-doc
- description:
- Generate technical design documents with proper structure, diagrams, and implementation details. Use when designing a new feature, documenting architecture decisions, or planning refactoring work. Default language is English.
- category:
- documentation
- tags:
- [design-doc, architecture, adr, rfc, technical-spec]
- argument-hint:
- [feature-name]
- allowed-tools:
- Read, Write, Glob, Grep
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 |
2. Gather Context
Explore the codebase before writing:
- Identify affected components using
GlobandGrepfor related code. - Read existing implementations and patterns.
- Note dependencies and potential side effects.
- Check for similar solutions already in the codebase.
3. 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.
4. 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.
5. 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.
6. Output Location
- Look for a
docs/,ai_docs/, ordesign/directory in the project. - Ask the user if the location is unclear.
- Save with a descriptive filename such as
design-[feature-name].md.
Related Skills
bahayonghang/code-refactor
development
VerifiedTrustedCommunity
Implement safe, behavior-preserving code refactors after inspecting the existing project. Use when the user asks to refactor code, split large files or modules, extract functions or methods, reduce duplicated logic, rename confusing classes/functions/variables, improve code comments, remove unused or dead code, or says 重构代码, 拆分模块, 提取方法, 减少重复代码, 优化命名, 优化注释, 删除未调用代码. For broad refactor requests, plan safe slices and wait for approval; for narrow scoped requests, directly implement the smallest verifiable slice.
15SKILL.mdUpdated Jun 6, 2026
bahayonghang/codex-dynamic-workflows
development
VerifiedTrustedCommunity
Use only when the user explicitly asks for swarm, subagents, parallel agents, dynamic workflow, multi-agent orchestration, 多智能体编排, or when the task truly needs coordinated research plus implementation plus review plus verification packets. Do not use for ordinary code review, planning-only work, single-line bugfixes, routine audits, or migrations unless orchestration is requested or at least two independent workflow dimensions are present.
15SKILL.mdUpdated Jun 4, 2026
bahayonghang/code-quality-review
development
VerifiedTrustedCommunity
Run a code quality review focused on maintainability, structure, abstraction quality, file growth, branching complexity, boundary cleanliness, and refactoring opportunities. Use when the user asks for code quality review, code review, maintainability review, architecture quality review, PR code quality feedback, 代码质量审查, 代码质量 review, 可维护性审查, 架构质量审查, or review comments about code structure. Do not use for pure security review, formatting-only review, performance profiling, or implementation tasks unless the user also asks for a code quality review.
15SKILL.mdUpdated Jun 4, 2026
bahayonghang/spark
development
VerifiedTrustedCommunity
Plan-first brainstorming workflow that turns an idea into an approved Markdown implementation plan by default. Use when the user wants to brainstorm, design, scope, or plan a feature/spec before implementation. Spark explores project context, asks only blocking questions, writes the plan under the project root's .plannings/YYYY-MM-DD-feature-slug.md path, self-reviews it, and waits for user approval. Create an HTML or visual plan/spec only when the user explicitly asks for HTML, browser-viewable, or visual output; save the paired .html beside the Markdown plan.
15SKILL.mdUpdated May 29, 2026