cs-doc-tutorial
Installation
SKILL.md
cs-doc-tutorial
启动必读
开始任何判断或动作前,先执行 CodeStable preflight:读 .codestable/attention.md;缺失先 cs-onboard;不读外部 AI 入口替代(详见 .codestable/reference/execution-conventions.md)。
代码解决问题,文档让别人能用它解决问题。spec 记录"做了什么、为什么这么做",但下游开发者和终端用户不需要、也不应该读 spec——他们需要面向自己角色的、可发布的指南。doc-tutorial 就是从 spec 和代码出发写成读者真正能用的指南。
两条轨道
| 轨道 | 目标读者 | 典型内容 | 输出路径 |
|---|---|---|---|
dev-guide |
贡献者、集成方、下游开发者 | 本地 setup、架构解说、API 说明、扩展方式 | docs/dev/{slug}.md |
user-guide |
终端用户 | 功能概述、操作步骤、概念解释、常见问题 | docs/user/{slug}.md |
轨道选择从"谁读"出发——同一个 feature 经常需要两份:API 变化进 dev-guide,对应的用户操作进 user-guide。