Operational Knowledge
Operations skills that drive command-line tools — deploying, rotating a cache, checking a service — can be written as knowledge articles and then used directly through an Agent conversation. A knowledge service Agent reads the runbook, runs the commands in its runtime and reports back, so the procedure is documented and executable in one place.
Getting the procedure into the knowledge base
Pick the source that matches where the procedure lives today:
- Notes for procedures that only exist in people's heads or chat threads. Save the steps as a note — original text, verbatim excerpts or a labeled summary — and let the Note Indexer turn it into a reader-facing article. Proposals stay proposals; the article does not turn them into facts. See Notes.
- Same-repository docs for runbooks and authored Skills already kept next to the code, such as under
docs/or.agents/skills/. Register them as an entrance; the originals remain the only place to edit them. See Same-Repository Docs. - Document sources for runbooks maintained in a document system.
Write each procedure as concrete steps: the commands, the expected output, how to tell success from failure, and when to stop and ask a person.
Variables, not values
Configure the environment variables a procedure needs in the Agent runtime. The knowledge names the variables only — never their values. Credentials stay on the server side and never enter knowledge, prompts or replies, so a procedure is safe to publish in a package or on a site.
Keeping runbooks current
When a procedure changes, update its source and let the normal update flow revise the article. If the source is right but the article misleads, revise only that page. When an article ends up more accurate than the document it came from, see Writing Back Upstream for keeping the two from drifting apart.
运维知识
驱动命令行工具的运维技能——部署、轮换缓存、检查服务——可以写成知识文章,再直接通过 Agent 对话使用。知识服务 Agent 阅读运维手册,在自己的运行时中执行命令并汇报结果,于是流程的文档和执行都集中在一处。
把流程放进知识库
按流程目前所在的位置选择对应的来源:
- 笔记:适用于只存在于人脑或聊天记录中的流程。把步骤保存为笔记——原文、逐字摘录或带标注的摘要——再由 Note Indexer 把它整理成面向读者的文章。提议仍是提议;文章不会把它们写成事实。参见笔记。
- 同仓库文档:适用于已经和代码放在一起的运维手册和自编 Skill,例如位于
docs/或.agents/skills/下的内容。把它们登记为入口;原文仍是唯一的编辑位置。参见同仓库文档。 - 文档来源:适用于在文档系统中维护的运维手册。
把每个流程写成具体步骤:要执行的命令、预期输出、如何区分成功与失败,以及何时应停下来询问人。
只写变量,不写值
在 Agent 运行时中配置流程所需的环境变量。知识里只写变量名——绝不写它们的值。凭据保留在服务端,绝不进入知识、提示词或回复,因此流程可以放心地发布到知识包或站点中。
保持运维手册最新
流程变化时,更新它的来源,让常规的更新流程去修订文章。如果来源没错而文章有误导,只修订那一页。当文章最终比它所依据的文档更准确时,参见回写上游,避免两者逐渐脱节。