dsh-doc-sync
Skill4 starsChanged 3 months agoMITView on GitHub
改动代码后使用：同步 README、CHANGELOG、版本号与示例，避免文档漂移。
In this repository18 other files it gives its agents.
- dsh-changelogSkill
- dsh-chinese-docsSkill
- dsh-code-reviewSkill
- dsh-debug-sessionSkill
- dsh-dependency-auditSkill
- dsh-git-commitSkill
- dsh-office-artifactsSkill
- dsh-plugin-clientSkill
- dsh-plugin-devSkill
- dsh-plugin-i18nSkill
- dsh-plugin-publishSkill
- dsh-preset-authoringSkill
- dsh-pr-reviewSkill
- dsh-refactor-safeSkill
- dsh-skill-adapterSkill
- dsh-task-breakdownSkill
- dsh-test-firstSkill
- dsh-webapp-testingSkill
The file
Files
文档与代码同步
改动后必查清单
- README 的安装/用法示例是否还能跑通（示例代码必须实际执行验证）
- 配置项、命令参数、字段名是否与实现一致
- 版本号：package.json 与文档里引用的版本是否一致
- CHANGELOG 是否记录了本次变化（遵循 Keep a Changelog）
- 注释：行为变了，旧注释是否变成误导
原则
- 过期文档比没有文档更糟：宁可直接删除过时段落，也不要留着错误示例
- 文档里出现命令时，用代码块并标注运行环境（版本、平台）
- 无法验证的行为不要写进文档；写"未验证"而不是"应该可以"
- 文档改动与代码改动放在同一个提交里，保证可追溯
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.