cli工具文档需分三类生成:--help输出须纯文本、祈使句、无换行;man页须groff格式、含指定section;swagger json schema须小驼峰字段、无自然语言描述。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要为同一套脚本参数生成三类正式文档:命令行 --help 输出需严格对齐终端显示、man 手册页要适配 groff 渲染、API 接口文档得嵌入 Swagger JSON Schema 字段。直接让 ChatGPT “写参数说明” 会混用口语化描述和模糊限定词,比如把 “--timeout 可选” 写成 “建议你加上这个参数”,导致下游工具解析失败或 CI 构建报错。
生成终端友好型 --help 文档
第一步:在提示词开头明确角色与约束——“你是一名 CLI 工具开发者,正在为 Python 脚本 myscript.py 编写 --help 输出内容,只输出纯文本,不加任何解释、不带代码块标记、不换行描述”。【若不锁死输出格式,ChatGPT 会自动插入 Markdown 表格或缩进空行,终端无法正确截断】
第二步:强制指定字段结构——“按以下顺序组织:首行是命令摘要;空一行后写 Usage 模板(形如 myscript.py [OPTIONS] );再空一行后列出所有参数,每行格式为 --option, -o
第三步:注入真实参数样例——“参数包括:--input, -i
用于在用户想通过浏览器自动化与 Google Gemini 或 ChatGPT 交互时。触发短语包括“ask Gemini”“ask ChatGPT”“ask GPT”“让...”。
生成 man 手册页兼容文本
方法一:用 groff 风格锚定语法
在提示词中写:“请生成符合 man 手册第1节规范的纯文本,要求:① 标题行格式为 ‘MYSRIPT(1)’;② SECTION 必须包含 NAME、SYNOPSIS、DESCRIPTION、OPTIONS、SEE ALSO;③ OPTIONS 下每个参数用 .TP 缩进,描述文字前不加冒号,结尾不加句号”。
方法二:反向校验法
追加指令:“生成后,请自查是否满足:所有长选项(--xxx)必须出现在短选项(-x)之前;每个 .TP 条目后必须空一行;SEE ALSO 行必须写成 ‘myscript(1), config.json(5)’ 格式”。
生成可嵌入 Swagger 的 JSON Schema 片段
直接输入:“你是一位 OpenAPI 3.0 规范工程师,请将以下参数转为 JSON Schema object 属性定义:--input 是必需字符串,格式为 file-path;--verbose 是布尔值,默认 false;--dry-run 是布尔值,默认 false。输出仅含 properties 字段内容,不包外层 schema 或 components,字段名用小驼峰(inputPath/verboseMode/dryRunEnabled)”。
这一步必须禁用自然语言描述——删掉所有“该参数用于……”“表示是否……”这类句子,否则 Swagger UI 无法识别字段类型。










