接入指南(人 + Agent)
状态:Active / 接入规则 最后更新:见 git log
本文回答两个问题:谁能改什么 与 不同消费对象如何读取事实源或派生包。详细协议在 governance/。
0. 当前仓库边界
| 类型 | 位置 | 说明 |
|---|---|---|
| 生态事实源 | ecosystem/ | 生态级白皮书、当前基线、对象注册和统一术语 |
| 项目知识库 | projects/ | 各项目的战略、产品、设计、执行计划和项目级事实 |
| 公共沉淀 | commons/ | 跨项目方法论、框架、模板、case、技能、参考与 playbook |
| 治理协议 | governance/ | 变更、对齐、职责、升级、工具接入、闭环和 reader testing 协议 |
| Agent 派生包 | for-agents/ | 从事实源派生的机器消费入口、路由和项目包 |
工程执行产物不作为公开知识库入口的一部分。本仓库只保留对人可读的战略、产品、设计、计划、索引和经治理后的评估结论;具体代码仓、运行日志、Controller state、handoff、task-packet 等执行态材料留在对应工程仓或私有运行环境中。
1. 事实源与派生物
| 角色 | 位置 | 谁能改 |
|---|---|---|
| 事实源 | ecosystem/ projects/ commons/ governance/ 下的 .md | 人;Agent 经评审回写 |
| 派生物 | for-agents/ 下绝大多数文件 | 不手改,只由 scripts/derive-agent-pack.mjs 生成 |
| 公开站点目录 | sidebars.js 生成的 Docusaurus sidebar | 不逐文档手改;由目录扫描 + verify:kb site-nav 自动校验可达性与入口标题 |
| 派生物中的例外(手写源) | for-agents/topics/<topic-id>/agent-pack.yaml —— topic 是一种「跨源聚合」请求,只能由人显式声明,因此该文件是派生区内唯一允许手写的 manifest source。其它字段(含同目录的 manifest.json / llms.txt / docs/)仍由派生脚本基于此 yaml 生成 | 见 for-agents/topics/README.md |
| 过程记录 | 本仓库不承载大量过程记录;公开文档只保留可审查的摘要、索引和结论,不暴露私有本地路径 | 见对应项目的执行索引 |
2. 消费入口
2.1 人版入口
| 你的角色 / 任务 | 入口 |
|---|---|
| 人 · 首次理解仓库 | README.md → ACCESS.md → ecosystem/current-baseline.md → ecosystem/object-registry.md |
| 人 · 接入项目 | projects/<id>/README.md |
| 人 · 改公共入口 / 治理 | governance/change-protocol.md |
| Controller · 恢复 | 对应工程仓 / 项目内 execution/<version>/state.md |
2.2 Agent 接入顺序(唯一入口)
任何 Agent,第一份读的文件是 for-agents/llms.txt,不是 README.md。
1. for-agents/llms.txt # 口袋指南(< 50 行)
2. for-agents/manifest.json # 结构化路由(含 entrypoints + packs 状态)
3. 按任务类型读对应 pack:
├ 项目接入 → for-agents/projects/<id>/
├ 议题维护 → for-agents/topics/<topic-id>/ (由 agent-pack.yaml 派生)
├ 全生态理解 → for-agents/ecosystem/
└ 治理 / 变更提议 → governance/change-protocol.md (Agent 直接读源)
for-agents/llms.txt 与 manifest.json 之间没有"先后顺序"的歧义:llms.txt 是入口,manifest.json 是它内部告诉 Agent 接下来读的结构化路由。
3. 写入边界(粗粒度,细节见 governance/change-protocol.md)
- ecosystem/ 的变更:必须走
governance/change-protocol.md的"生态级"流程; - projects/
/ 的变更:由对应项目 Controller 或被授权人提议,回写需经评审; - commons/ 的新增:欢迎沉淀,但 frontmatter(
scope/maturity)必填; - governance/ 的变更:所有人都要按 ADR 记录,理由可追溯;
- for-agents/ 的变更:禁止手改,唯一例外是
for-agents/topics/<topic-id>/agent-pack.yaml(见 §1 表格)。 - 公开站点目录:新增或移动文档后运行
npm run verify:kb -- --only site-nav或npm run build;如果失败,修正文档位置、入口 README 标题或sidebars.js的生成规则,而不是在站点产物里手工补目录。 - 公开正文质量:所有公开 Markdown 必须带统一 frontmatter;保留目录应使用
status: reserved,不得标成 active;公开正文不得暴露个人本地路径;链接标题必须是人可读名称,不能是../xxx.md这类路径文本。npm run verify:kb -- --only content-hygiene会自动检查这些基础问题。
4. 文档基本规范
- 每篇公开
.md顶部 frontmatter 至少包含:title / status / last-updated / scope / maturity; - 公开正文不得写入个人本地绝对路径、用户主目录下的工程路径、私有配置目录或容器工作目录;如必须说明来源,只写“私有工程仓”“参考仓”“本地运行目录”等角色化名称;
- Markdown 链接的显示文本必须是人可读标题,例如“生态当前基线”,不能显示为
../../ecosystem/current-baseline.md; - 单篇文档禁止中英文混排:默认中文(专名、产品名、代码标识、URL 保留英文);如必须整篇英文,需在同目录下放一份配套中文摘要;
for-agents/**例外:派生区为 LLM 优化,允许英文(如for-agents/llms.txt);但派生的源 .md 仍受单篇不混排规则约束,派生时如需翻译/改写应在派生脚本中处理;- 术语对齐 统一术语表,新概念先入 glossary 再投入使用。
5. Agent 指令最小模板
你正在接入 Labs-FinTecAI。
任务对象:<生态 / 项目 / 议题 / commons 资料>
本轮目标:<一句话>
读取:
- for-agents/llms.txt
- for-agents/manifest.json
- <任务相关的派生包或源文档>
读取边界:
- 不全量扫描仓库
- 不改 for-agents/ 下任何文件(topics/<id>/agent-pack.yaml 除外)
- 事实源变更走 governance/change-protocol.md
输出:
- 关键结论 + 证据引用(含 commit/file/anchor)
- gap / proposal / risk
- 是否需要 sync / escalation
- 下一批建议读取文件
完成后停止。