代理入门

你是一个刚刚被引入使用 folio-assistant 的代码仓库的 LLM 代理。本页面是你的入职指引:你正在面对什么、第一步该做什么,以及在何处查阅资料。

有关技能、角色和能力的架构,请阅读技能与角色。本页面则是其实操版本。

  1. 1. 搞清楚你位于哪个仓库中
  2. 2. 你的前五分钟
  3. 3. 寻找合适的技能 — 切勿即兴发挥
  4. 4. 内容对象模型简述
  5. 5. 两种依赖关系 — 切勿混为一谈
  6. 6. 在 beans 中跟踪工作,不要凭记忆跟踪
  7. 7. QA 附属文件与维度轴
  8. 8. 交付工作
  9. 9. 查阅信息的位置
  10. 10. 让你避免陷入麻烦的良好习惯

1. 搞清楚你位于哪个仓库中

仓库有两种类型,在早期将它们混淆是最常见的错误。

folio-assistant(平台)作品集(folio)(内容仓库)
包含内容技能、模式、流水线、MCP 服务器实际的论文 / 指南 / 实施指南(IG)
拥有 content/<paper>/否 — 仅有 content/pipeline/是
你在此编辑以修改创作的工作机制修改正在创作的内容
ls content/          # pipeline/ only  ⇒ platform;  paper dirs ⇒ folio

folio-assistant 不包含任何具体内容。 如果你发现自己正准备向其中编写具体主题内容——章节、常量、章节关键词列表——说明你位于错误的仓库中,或者你正在编写的内容应当由 folio 提供数据。参见 §7。

2. 你的前五分钟

beans prime && beans list      # the work-plan — see §6
scripts/session-start-coord-sweep.sh   # CLI-independent equivalent
bun run src/index.ts --check-deps      # what this environment can do

--check-deps 的重要性远超表面。当缺少工具(无 Lean 工具链、无 Atlas、无 LaTeX)时,许多检查项会降级为 n/a 而不是直接报错。n/a 并不代表通过。 如果你在不清楚哪些检查被跳过的情况下报告“一切正常”,你实际上是将数据的缺失作为了测试结果。

3. 寻找合适的技能 — 切勿即兴发挥

技能是这里的工作单元。在手动编写流程之前,先检查是否已存在现成的技能。

位置它为你提供的内容
skills/folio-core/内容无关:协调、监视器(watchers)、QA、渲染、参考书目
folio-assistant-sci/skills/content/folio-paper-adapter/论文:Lean、LaTeX、证明、模拟器
smart-base/skills/content/authoring-who-smart-guidelines/WHO SMART DAK / IG
技能模式参考每项技能生成的输入/输出契约
技能指令生成的完整指令主体
技能与角色技能、角色与能力如何组合

两个 reference/ 目录都是自动生成的 — 绝不要手动编辑它们。请使用 bun run scripts/gen-schema-docs.ts 和 bun run scripts/gen-skill-docs.ts 重新生成。

4. 内容对象模型简述

内容块是由共享相同根名称的三元组组成的:

<block>.ts     manifest — label, kind, uses[], lean.ref, cites[]
<block>.md     the narrative a reader actually reads
<block>.lean   the formalisation (when the kind requires one)
<block>.qa.json  QA sidecar — audit results, per criterion

.ts 清单文件是结构的单一真实来源。形式化状态是在构建时派生出来的,绝不会存储在清单中。

5. 两种依赖关系 — 切勿混为一谈

这经常让代理们陷入困境。

  • uses[] 属于编辑层面的依赖。“读者必须先阅读什么才能理解这个内容块?” 由人工/代理撰写并维护。
  • 形式化图是机器派生的,派生自 lean.ref,绝非手动编写。

它们在两个方向上都存在合理的差异:证明可能会调用不需要读者阅读的 simp 引理;而定理可能由某个从未被形式化引用的示例所启发。

绝不要从 Lean 中自动填充 uses[]。 这会破坏计算每项排序指标所依赖的信号。对于影响分析问题(“如果修改此项会破坏什么?”),请取两者的并集:

bun run content/pipeline/content-graph.ts content/<paper>

审计 uses[] 是否合理使用属于其专属技能:uses-editorial-review,外加机械化的 uses QA 轴。

6. 在 beans 中跟踪工作,不要凭记忆跟踪

beans 是唯一的待办事项机制 — 既作用于会话本地,也跨代理共享。beans/ 目录已纳入提交,因此工作计划可以在全新容器中恢复会话时留存下来。

beans list
beans create "<title>"
beans update <id> --status in-progress    # CLAIM before you work

在开始工作前先进行申领,以免两个会话认领同一项任务;并且绝不要解决或删除同伴的 bean。不要建立平行的待办事项存储。不要用 beans create 来批量创建机器生成的队列(*.qa.json、证据文件等)— 这些应保留为批量 JSON。

完整规范:skills/sdlc/sdlc-core/todo-manager.md、skills/sdlc/sdlc-core/bean-coordination.md。

7. QA 附属文件与维度轴

每个内容块都可以附带一个 <block>.qa.json,按标准记录每位评审员的发现 — 包括 script、agent 或 human。记录项在审计时带有源文件哈希值,因此在内容块被编辑时,记录项会过期,必须重新判定。

评判标准按维度轴分组(proof、voice、detangler、uses、canonical、compute、bibliography 等)。运行其中一个轴:

bun run content/pipeline/qa-sweep.ts --axis uses content/<paper>
bun run content/pipeline/qa-staleness.ts content/<paper>

有些标准是 automated: true(由脚本判定),有些则是 automated: false(必须由代理或人工裁决)。第二种会消耗实际交互轮次 — 参见 semantic-cone.ts,了解如何根据其实际能影响的范围来界定其执行范围。

作品集可选维度轴。 编码某个作品集特定主题的维度轴仅在作品集明确选择启用时才会注册:

// <name>.config.json
{ "qaAxes": ["q-usage"] }

同样,作品集专属的数据属于作品集本身,而非平台 — 例如 content/<paper>/topic-keywords.json 驱动 detangler-topic-coherence,若缺少该文件,检查器将报告 n/a。

8. 交付工作

/prepare-merge [base]

运行通用配方以及特定内容类型的关卡(论文 → content_validate / qa_sweep / proof_status / latex_preflight / lean_build),然后执行推送。它不会执行合并。

监视同伴的 PR:/watch <pr|branch>。

9. 查阅信息的位置

问题解答
项目命令、约定AGENTS.md(代理通用的单一真实来源)
某个技能的作用skills/**/,或生成的指令主体
技能的类型化契约技能模式参考
QA 判据的含义content/pipeline/qa-criteria-registry.ts — 其中的描述即为规范
内容块模式schemas/types.ts
QA 附属文件模式schemas/block-qa.ts
当前环境能够执行的操作.claude/skills/capabilities/*.json、--check-deps
Lean 工具链路线图Lean 工具集成提案

10. 让你避免陷入麻烦的良好习惯

  • n/a 并不代表通过。 阐明跳过了什么以及跳过的原因。
  • 在开展持久工作前申领 bean。 其他会话可能正在运行。
  • 不要硬编码论文名称。 一个作品集可能包含多篇论文;使用 content/pipeline/repo-root.ts 中的 findPapers() / soleFolioPaper() 解析。
  • 不要将具体内容写入平台中。 如果它涉及章节名称、常量或词汇表,则属于 folio 数据。
  • 对于 docs/reference/ 下的任何内容,重新生成,切勿手动编辑。
  • 在对检查发现采取行动前,先阅读判据描述。 它们陈述了严重程度、意图以及明确不算作违规的情况。

folio-assistant — code under the Apache License 2.0, documentation under CC BY 3.0. Generated schema and API references are rebuilt from source on every push to main.

deployed dev