Codex AgentsMesh 技术文档:把公开接口与运行示例写清楚
EnglishCodex 安装步骤
- 打开固定版本的 GitHub 原文。在该版本的工作副本中保留 `.agents/skills/am-agent-code-documenter/` 整个目录。
- 在目标项目中打开 Codex,输入 `$am-agent-code-documenter` 并给出本页示例里的任务和所需输出。
中文摘要
从实际代码和消费者需求组织开发文档、API 说明或入门指南。核对术语、导航、示例和随代码变动需要更新的位置。
SKILL.md 中文导读
可复现示例
给 `$am-agent-code-documenter` 一个本地练习导出函数。请写开发者入门段落,含输入、输出和能重现的运行示例。工作步骤
- 识别读者最先要完成的任务,按公开入口核对行为和依赖。
- 写与实现对应的可验证示例,并检查术语、索引和后续维护位置。
验收方法
指南可从公开入口验证,读者知道怎样构造输入与识别正确输出。
GitHub 原文 · 更新日期
适用环境
Codex 与 AgentsMesh 或目标项目工作副本,准备目标读者、可读的源码与已有说明。
常见问题
如何防止文档和代码分开演进?
从文档链接到实际接口与示例检查。行为发生变化时一并核对关联说明。