SuperAPI AI 工具集

ln-002-best-practices-researcher

写作与研究

查看项目

更新于 10-15 23:59

技能介绍

用途:先研究行业标准与最佳实践,再一次性产出项目文档,并可替代 ln-321-guide-creator、ln-322-adr-creator、ln-323-manual-creator。

主要能力:支持四类文档:guide(模式文档,含 Do/Don't/When 表)、manual(API/库参考)、adr(架构决策记录,通过 5 问对话生成)、research(针对具体问题的调研)。会先做技术栈检测(.NET、Node.js、Python、Go、Rust、Java),为检索加上查询前缀并链接对应官方文档。

必要用法:输入 doc_type(guide/manual/adr/research)与 topic 必填,story_context 可选。研究使用 ref_search_documentation、context7__resolve-library-id、context7__query-docs 和 WebSearch,研究时间建议控制在 5–10 分钟。通用流程为:检测编号 → 研究 → 按模板生成 → 校验(SCOPE、POSIX)→ 保存 → 返回路径。输出目录分别为 docs/guides/、docs/manuals/、docs/adrs/、docs/research/,文件需命名规范,若目标目录不存在必须创建。模板位于 shared/templates/ 下,且必须阅读 shared/references/research_tool_fallback.md。

适用场景:需要为某主题补齐基于标准的文档时,例如 ln-310-multi-agent-validator 检测到文档缺失,或需记录模式、库、架构决策。

限制:所有文档禁止放置代码示例(超过 1 行的代码块不可用),应优先使用表格、ASCII 图,列表仅用于枚举,纯文本为最后手段。每个 guide 只写一个模式,每个 ADR 只记一项决策,每个 manual 只覆盖一个包。引用来源需带版本或日期且不超过一年。文档语言沿用 story_context 的 EN/RU。每次调用只研究一次并复用结果。费用与平台信息暂未提供。