codex可自动从git仓库、本地工程或ui描述生成用户手册初稿;需提供结构化源材料,按指令限定范围与格式,人工修正术语后插入截图导出pdf。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要为新上线的内部工具快速产出一份结构清晰、术语统一、带截图标注的用户手册,但又不想从零写起、反复校对格式、手动更新版本——Codex能直接读取你的代码仓库或UI工程文件,自动提取功能点、操作路径和界面元素,生成符合技术文档规范的初稿。
准备可解析的源材料
Codex 生成手册的前提是它能“看懂”你的产品。不支持直接上传PDF说明书或截图堆叠包。必须提供结构化、可读取的原始输入。
方法一:接入 Git 仓库(推荐)→ 在 Codex 项目创建页选择「Connect to Git」→ 输入 GitHub/GitLab 仓库 HTTPS 地址 → 粘贴个人访问令牌(PAT)→ 点击「Sync now」。
方法二:拖入本地工程文件夹 → 点击左侧「+ New Project」→ 选择「Local folder」→ 浏览并选中含 src/、public/ 或 docs/ 目录的根文件夹 → 注意:必须包含至少一个 package.json、README.md 或 index.html 文件,否则 Codex 无法识别项目类型,【不会触发任何文档解析逻辑】。
方法三:粘贴 UI 描述文本 → 在对话框中输入:“这是我们的数据看板页面:顶部有时间筛选器(下拉单选)、中间是折线图(X轴为日期,Y轴为请求数),右上角有导出按钮(图标为↓箭头)。” → 这种方式仅适用于无代码资产时的临时补救,生成内容准确性大幅下降。
触发文档生成指令
确保当前处于已连接项目的对话窗口中,不是全局聊天页。
第一步:明确指定输出格式与受众 → 输入:“请为普通业务人员编写一份用户手册,用中文,按功能模块分章节,每章包含操作步骤、界面截图位置说明、常见问题提示,不要出现代码片段。”
第二步:限定范围防止泛化 → 补充一句:“只覆盖 dashboard 页面和 settings > notification 子页面,忽略 login 和 admin 模块。”
第三步:启用截图标注支持 → 输入:“所有提到的按钮、输入框、图表区域,请在对应文字后用【截图标注:A】【截图标注:B】形式标记,我后续会插入真实截图替换。”
通过本地 Codex 或 OpenClaw OAuth 凭证直接调用 ChatGPT/Codex Responses 的 image_generation 工具来生成或编辑光栅图像,然后保存
这一步操作起来很简单,直接把三句话连续发送即可。Codex 会在 10~45 秒内返回 Markdown 格式初稿,含标题层级、列表、标注占位符。
修正术语与风格偏差
Codex 默认采用通用技术文档语感,但你的团队可能有专属叫法。比如你们管“导出按钮”叫“下载快照”,管“时间筛选器”叫“时段滑块”。必须人工干预一次。
在生成结果中全选 → Ctrl+F 查找“导出按钮” → 替换为“下载快照”;同理查找“时间筛选器”→ 替换为“时段滑块”。
注意:不要跳过这步。Codex 不会主动学习你替换后的术语,下次生成仍会复用旧词,【术语不统一将导致多份手册间产生理解歧义】。
检查 H2 标题是否全部以动词开头(如“配置通知渠道”而非“通知渠道设置”),不符合则手动调整。Codex 生成的标题偶尔会偏静态,而用户手册规范要求行为导向。
插入真实截图并导出
打开你的产品网页或本地预览服务 → 截取 dashboard 页面全图 → 用 Snipaste 或系统自带工具,在图中标出 A、B、C 区域(对应文档中【截图标注:A】等位置)→ 保存为 PNG。
回到 Codex 对话页 → 点击右侧「Attachments」面板 → 将刚保存的 PNG 拖入 → Codex 自动识别图中带字母标注的区域,并在文档对应位置插入图片链接。
最后点击右上角「Export」→ 选择「PDF (with styling)」→ 勾选「Include cover page」→ 点击「Download」。文件将按当前项目名+日期命名,自动下载到默认目录。










