easysdd-guidedoc

Installation
SKILL.md

easysdd-guidedoc

代码解决问题,文档让别人能用它解决问题。spec 文件记录了"做了什么、为什么这么做",但下游开发者和终端用户不需要、也不应该读 spec——他们需要的是面向自己角色的、可发布的指南。

guidedoc 就是从 spec 和代码出发,写成读者真正能用的指南。


两条轨道

轨道 目标读者 典型内容 输出路径
dev-guide 贡献者、集成方、下游开发者 本地 setup、架构解说、API 说明、扩展方式 docs/dev/{slug}.md
user-guide 终端用户 功能概述、操作步骤、概念解释、常见问题 docs/user/{slug}.md

轨道选择从"谁读"出发,不从"写的是接口还是步骤"出发——同一个 feature 经常需要两份:API 变化进 dev-guide,对应的用户操作进 user-guide。

路径 docs/dev/docs/user/ 是默认约定,项目已有自己的 docs 结构就以项目为准——开始前先确认。

Related skills

More from liuzhengdongfortest/easysdd

Installs
93
GitHub Stars
147
First Seen
Apr 14, 2026