easysdd-libdoc
Installation
SKILL.md
easysdd-libdoc
guidedoc 教你"怎么用 X 做 Y",libdoc 告诉你"X 的每个零件长什么样、怎么配"。两者性质完全不同,写法、信息源、粒度都不一样。
guidedoc 写错可能是表达不清,libdoc 写错就是错——因为它的信息源是源码本身,类型、默认值、签名都有唯一正确答案。libdoc 的核心规则是不靠猜、不复制改名、每个条目独立读源码。
和 guidedoc 的对比
| guidedoc | libdoc | |
|---|---|---|
| 性质 | 任务导向(Tutorial / How-to) | 参考导向(Reference) |
| 回答 | "如何用 X 实现某个目标" | "X 的每个零件长什么样、怎么配" |
| 粒度 | 一个 feature / 一个场景一篇 | 一个条目(组件/函数/命令)一篇 |
| 信息源 | 方案 doc + 用户知识 | 源码本身(类型定义、注释、默认值) |
| 数量级 | 几篇到十几篇 | 几十到上百篇 |
互补:guide 引用 libdoc 条目做详细参考("完整 props 见 xxx"),libdoc 条目的"相关条目"链回对应 guide。