Menu

Individual skill

dsh-doc

0upvotes

创建或维护工程文档、设计决策、事故复盘、归档提案或产品迁移指南时使用，保留事实依据、实际备选方案和准确状态。

skills/dsh-doc/SKILL.md

Read pinned source

Source commit a8cee8831f288376b8cc5d7d0d28485a03911c1e

What was checked

Matches the observed repository HEAD
Yes
Scanner rules are current
Yes
Repository scan complete
No
Skill scan complete
Yes
Observed behavior
Instructions only
Last checked
Nov 9, 2026

These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.

Install this skill

Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.

An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.

Repository context

Repository stars (not skill ratings)
1,869
Repository last updated
Nov 1, 2026
License
MIT

Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.

Files and excerpt

File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.

Browse files
Read excerpt

# 维护有用的工程文档

阅读[项目上下文](references/project-context.md)和[文档写作](references/prose.md)。创建文档前，先找到现有负责维护相关事实的位置。

1. 明确读者、任务和实际源码行为。涉及默认值、输入输出、失败恢复及兼容性时，阅读实现和真实示例。
2. 选择下面与任务有关的流程，只组合请求需要的部分。
3. 优先修改事实的现有维护文档，更新导航和指向它的链接，并在任务范围内清理矛盾的重复说明。沿用项目的文档约定和语言。
4. 验证示例、路径和链接，对照代码检查语义。格式检查不能证明事实正确或内容完整。适用时执行项目必需检查。

## 当前行为文档

说明前置条件、受支持用法、代表性示例、重要限制和失败行为。注释解释行为约定或不明显的选择，不记录修改过程。公开行为变化时，在同一次改动中更新读者实际使用的入口文档。

## 决策和事故记录
Back to top