我在重写README这件事上浪费的时间,多到我不想承认。后来干脆动手写了个命令行工具,喂给它几行要点和粗糙笔记,它就能吐出结构清晰、能直接用的Markdown文档。
背后跑的是部署在Oxlo.ai上的一套流程。整件事的核心就是一个Python脚本,你用这个思路可以复制到API文档、运维手册、内部wiki之类的场景里。
准备工作就三样:Python环境装到3.10以上、去portal.oxlo.ai申请好API密钥,再装OpenAI的SDK。只需要一条 pip install openai。
第一步是初始化客户端。我在本地建了 tech_writer.py 这个文件,模型选了Llama 3.3 70B。理由是它跟得住比较长的系统指令,输出干净的Markdown,不掺废话。
客户端的初始化方式很简单,配置好Oxlo.ai的接入地址和环境变量里的密钥,调用 draft_doc 函数就能把笔记转成初稿。请求的温度参数设在0.3,保证生成结果足够稳定。
第二步是整个工具的灵魂——锁死系统提示词。你可以把这条提示词理解成产品本身,它把模型的语气、结构和格式全约束住了,让它拿出来的东西像资深技术写手,而不是个聊天机器人。
这条提示词里写了明确的规则:用简洁的语句,杜绝营销腔;输出必须有标题、前置条件、带编号的步骤,必要时加上排错部分;命令、文件路径和配置示例一律用代码块包裹。碰到模棱两可的输入,允许做合理假设,但必须在“备注”里说清楚。最后还强调只输出文档,别加任何元评论。
第三步是加上自检循环。初稿肯定有缺漏,我的做法是跑一轮批评后再跑一轮修订。在Oxlo.ai上这一来一回多了两次请求,但它的计费模式是每次请求一口价,就算笔记和草稿都很长,账单也不会坐过山车。具体费率可以在Oxlo.ai的定价页面上看到。
自检流程分成两个环节。先让模型拿着原始笔记对照草稿,列出所有缺步骤、含糊指引或者风格问题,而且必须具体。然后再把草稿和批评意见一起喂进去,让它基于批评重写全文,吐出一份完整的修改稿。两轮都用同一套资深技术写手的系统提示词来兜底。
整个工具就靠这样一条线跑通:用结构化的提示词定义文档标准,再用自检循环消除初稿里的信息盲区。它不保证一次就完美,但能把“写了再改”这个烦人的循环尽量压缩。
特别声明:以上内容(如有图片或视频亦包括在内)为自媒体平台“网易号”用户上传并发布,本平台仅提供信息存储服务。
Notice: The content above (including the pictures and videos if any) is uploaded and posted by a user of NetEase Hao, which is a social media platform and only provides information storage services.