Agent Skills
› videojs/video.js
› write-design-doc
write-design-doc
GitHub用于根据用户明确请求撰写或更新 Video.js 架构、功能或决策记录。通过阅读代码和现有文档，提炼非显而易见的rationale，生成简洁的设计文档。
触发场景
用户明确要求创建设计文档
用户明确要求修订决策记录
安装
npx skills add videojs/video.js --skill write-design-doc -g -y
SKILL.md
Frontmatter
{
"name": "write-design-doc",
"description": "Write or update a Video.js architecture, feature, or decision record only when the user explicitly requests that record. Use for compact, non-inferable rationale outside UI component design."
}
Internal records
Read internal/design/README.md and internal/decisions/README.md; they define current placement, status, and format.
Workflow
- Confirm that the user explicitly requested creation or revision of the record. Do not invoke this skill merely because a design decision exists.
- Use the requested artifact and path when given; otherwise choose the smallest matching design or decision location.
- Read the relevant code, tests, history, and existing record. Treat executable sources as current behavior.
- State the decision directly, then preserve only the important rationale, constraint, or trade-off that cannot be inferred from those sources.
- Link source, tests, or related records instead of copying APIs, schemas, state flow, file inventories, or mechanics.
- Include alternatives or consequences only when they materially explain the choice. Omit empty headings and speculative detail.
Keep the result to a few paragraphs when possible. Do not create adjacent records, split one record into several, or turn it into an RFC without a separate explicit request.
Example
Input: “Record why source selection belongs in the core player.”
Output: A compact decision and the non-inferable reason it should survive outside the code, with source links where useful.
版本历史
- 8a0a3d8 当前 2026-10-20 08:03
