SuperAPI AI 工具集

slopdocs

写作与研究

查看项目

更新于 10-16 02:23

技能介绍

用途

slopdocs 是一个文档归档约定,用来规定规划文档、缺陷调查和功能说明应当存放在哪里、以及何时应当创建。它的定位是“归档系统,而非写作流程”:内容由其他技能(如头脑风暴、写计划、系统化调试等)生成,slopdocs 负责决定这些内容放到哪个路径。

其核心动机是:规划文档、缺陷调查和功能说明是智能体产出的最有价值产物,代码反而是廉价的部分。没有这些文档,下一个智能体每次都要从零开始,重新推导同样的约束、重新争论同样的权衡。

目标读者

slopdocs 的读者是其他智能体,而不是人类。它是“一个智能体写给下一个智能体的笔记”,要求密集、粗糙但准确,用来保留那些否则会在每次会话中被重新推导的上下文。

项目可能同时存在面向人类的文档(通常在 docs/、README.md、wiki 或文档站点中),其目标不同(上手引导、公开参考、营销),行文规范也不同。slopdocs 不替代人类文档,也不应写入 docs/ 等面向人类的位置。如果用户只说“docs”而未指明类型,应当先询问,因为两者位置不同、读法差异很大,弄错会浪费工作。

目录约定

文档位于项目根目录的 slopdocs/ 下,包含三个子目录:

slopdocs/
├── features/
│   └── <feature>.md
├── bugs/
│   └── YYYYMMDD-<short-slug>.md
└── plans/
    └── YYYYMMDD-<feature>.md
  • slopdocs/features/<feature>.md:每个功能一份活文档,描述该功能当前如何工作,包括数据模型、关键逻辑、设计决策;功能变化时更新它。
  • slopdocs/bugs/YYYYMMDD-<short-slug>.md:每次缺陷调查一个文件,带日期前缀。修复本身留在提交历史中,文档保留上下文:走过的弯路、误导线索、根因分析。
  • slopdocs/plans/YYYYMMDD-<feature>.md:每次规划会话一个文件,带日期前缀。写代码前先写计划,发布后保留计划,因为阅读原始计划是日后理解功能最快的方式。

功能使用一份持续更新的活文档;缺陷和计划是时间点快照。日期前缀保持时间顺序并避免命名冲突。

何时写 slopdoc

  • 你花了大量时间思考它,或存在真正的架构分叉。
  • 某个缺陷的根因不明显,别人很可能再次遇到。
  • 你正在构建新功能,把已经生成的计划保存下来。
  • 某个决策在三个月后看起来会很奇怪,有人会想把它“重构”掉。

何时跳过

  • 差异本身就是文档:重命名、重新格式化、依赖升级。
  • 改动微不足道且容易回滚。
  • 写文档比写代码还费时。
  • 你只是在重复另一个 slopdoc 中已有的内容,应改为链接过去。

如何写

这些是工程师写给工程师的笔记。保持密集:先陈述决策,再给理由;记录尝试过的替代方案以及它们为何失败。杂乱的要点列表也可以。准确而粗糙胜过精致而过时。不要写供人类浏览的状态更新或摘要,而要写下一个智能体可以立即阅读并据此行动的上下文。

修改之前

在修改任何已有文档的功能之前,先阅读相关 slopdoc:查看 slopdocs/features/ 中的活文档,以及 slopdocs/plans/ 中关于该领域的历史上下文。

与其他技能配合

slopdocs 是归档系统,其他技能生成内容。当两者同时启用时,用其他技能的流程产出文档,然后保存到 slopdocs 路径,而不是该技能默认的位置。

与 superpowers(brainstorming、writing-plans、systematic-debugging)配合:

  • 头脑风暴 / 设计规格:用 brainstorming 技能的流程产出设计规格,保存到 slopdocs/features/<feature>.md,而不是 docs/superpowers/specs/。它成为活的功能文档,随功能演进更新。
  • 实现计划:用 writing-plans 技能的流程产出计划,保存到 slopdocs/plans/YYYYMMDD-<feature>.md,而不是 docs/superpowers/plans/。发布后保留计划。
  • 缺陷调查:用 systematic-debugging 技能的流程调查。当调查值得保留(根因不明显、多次走入弯路、别人会再次遇到)时,把记录保存到 slopdocs/bugs/YYYYMMDD-<short-slug>.md。

与任何其他产出文档的技能配合时同理:用技能来写,用 slopdocs 来归档。如果某技能把计划保存到 docs/plans/、.sisyphus/plans/ 或其他路径,按上述文件名约定重定向到对应的 slopdocs/ 路径。

没有其他技能启用时

按照“如何写”中的指引自行撰写文档,无需特殊流程,放进正确的文件夹即可。

限制

资料未提供该技能的安装命令、收费或价格信息、支持平台、具体效果数据,也未提供官方文档或代码仓库地址之外的更多细节。