design-documentation

A set of templates and guidance for writing structured software design documents, from feature proposals through architecture and detailed implementation.

In plain words
What is it for?
Use it to write feature RFCs, architecture designs, optional system designs, functional designs, and detailed designs for software projects.
Why use it?
It turns scattered design decisions into documents with consistent sections, responsibilities, interfaces, risks, and implementation details.

Skill for Claude CodeCodex

Part of the cpython-optimize-skill plugin — 35 skills, 9 agents, 2 hooks, 1 MCP server shipped together

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/sisibeloved/cpython-optimize-skill/design-documentation
Any agent
npx skills add sisibeloved/cpython-optimize-skill --skill design-documentation
Clone the repo
git clone --depth 1 https://github.com/sisibeloved/cpython-optimize-skill

Made for: Claude Code, Codex.

Or install cpython-optimize-skill, the plugin that ships this one along with the rest of its 35 skills, 9 agents, 2 hooks, 1 MCP server.

Per session 32 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,718 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00032 $0.03718
Opus 5 $0.00016 $0.01859
Sonnet 5 $0.00006 $0.00744
Haiku 4.5 $0.00003 $0.00372

Measured 2d ago against content hash f0b3ca074ed3, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

design-documentation scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

plugins/cpython-optimize-skill/skills/design-documentation/SKILL.md · 147 lines

How it starts

The opening of the file, as written. The whole thing — 147 lines — stays where its author put it; the contents beside it link to each section on GitHub.

设计文档编写

目标

按照标准模板编写结构化设计文档,覆盖从特性提案到架构、再到详细实现的完整设计层级。

设计流程

digraph design_flow {
    rankdir=TB;
    "特性设计(RFC,可选)" [shape=box style=dashed];
    "架构设计" [shape=box];
    "系统设计(可选)" [shape=box style=dashed];
    "功能设计" [shape=box];
    "详细设计" [shape=box];

    "特性设计(RFC,可选)" -> "架构设计";
    "架构设计" -> "系统设计(可选)";
    "架构设计" -> "功能设计";
    "系统设计(可选)" -> "功能设计";
    "功能设计" -> "详细设计";
}

自顶向下,上层输出是下层输入:

层级 文档 职责 模板
0 特性设计说明书(RFC,可选) 在正式设计前提出并评审特性:动机、目标/非目标、用例、总体方案、技术选型、风险与开放问题,用于对齐"做不做、怎么做" references/feature-rfc-template.md
1 架构设计说明书 定义整体架构、模块划分、逻辑/实现/部署模型、安全分析 references/architecture-design-template.md
2 系统设计说明书(可选) 定义系统级约束(可靠性、安全、生命周期)、专项设计、AI子系统 references/system-design-template.md
3 功能设计说明书 按功能域和功能项拆分实现方案、接口设计、DFX分析 references/function-design-template.md
4 详细设计说明书 描述具体接口或组件的内部实现、行为模型、数据模型 references/detailed-design-template.md

特性设计说明书(RFC)不是必选项。当某个特性需要先经社区/团队评审对齐(动机、边界、技术选型、风险)再进入正式设计时使用;特性较小、无争议时可直接从架构设计开始。系统设计说明书也不是必选项,当系统级约束(可靠性、安全、生命周期等)需要独立成文档时插入,否则相关内容直接写在架构设计说明书中。

文档类型选择

digraph design_doc_choice {
    "设计需求" [shape=box];
    "需先评审特性(动机/目标/边界/选型/风险)?" [shape=diamond];
    "特性设计说明书(RFC)" [shape=box];
    "定义整体架构、模块划分、部署模型?" [shape=diamond];
    "架构设计说明书" [shape=box];
    "定义系统级约束、可靠性、安全、生命周期?" [shape=diamond];
    "系统设计说明书" [shape=box];
    "描述功能域和功能项的实现方案?" [shape=diamond];
    "功能设计说明书" [shape=box];
    "描述具体接口或组件的内部实现?" [shape=diamond];
    "详细设计说明书" [shape=box];

    "设计需求" -> "需先评审特性(动机/目标/边界/选型/风险)?";
    "需先评审特性(动机/目标/边界/选型/风险)?" -> "特性设计说明书(RFC)" [label="是"];
    "需先评审特性(动机/目标/边界/选型/风险)?" -> "定义整体架构、模块划分、部署模型?" [label="否"];
    "特性设计说明书(RFC)" -> "定义整体架构、模块划分、部署模型?";
    "定义整体架构、模块划分、部署模型?" -> "架构设计说明书" [label="是"];
    "定义整体架构、模块划分、部署模型?" -> "定义系统级约束、可靠性、安全、生命周期?";
    "定义系统级约束、可靠性、安全、生命周期?" -> "系统设计说明书" [label="是"];
    "定义系统级约束、可靠性、安全、生命周期?" -> "描述功能域和功能项的实现方案?";
    "描述功能域和功能项的实现方案?" -> "功能设计说明书" [label="是"];
    "描述功能域和功能项的实现方案?" -> "描述具体接口或组件的内部实现?";
    "描述具体接口或组件的内部实现?" -> "详细设计说明书" [label="是"];
}

Read the full file on GitHub · 147 lines

Files

What ships with it

5 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 147 lines · 32 tokens per session scan A f0b3ca074ed3

Subscribe to this mod's changes

design-documentation is a skill published in the GitHub repository sisibeloved/cpython-optimize-skill (2 stars, last pushed 4d ago), licensed MIT. It adds 32 tokens to every session and 3,718 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation.

obra/superpowers · 37 tokens

auto-perf-optimize

Run agent-driven VS Code performance or memory investigations. Use when asked to launch Code OSS, automate a VS Code scenario, run the Chat memory smoke runner, capture renderer heap snapshots, take workflow screenshots, compare run summaries, or drive a repeatable scenario before heap-snapshot analysis.

microsoft/vscode · 62 tokens

chat-perf

Run chat perf benchmarks and memory leak checks against the local dev build or any published VS Code version. Use when investigating chat rendering regressions, validating perf-sensitive changes to chat UI, or checking for memory leaks in the chat response pipeline.

microsoft/vscode · 51 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens