网易首页 > 网易号 > 正文 申请入驻

我写了个Python脚本,把乱糟糟的笔记变成了能用的技术文档

0
分享至

我在重写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.

相关推荐
热点推荐
一只“北京鸭”,为何让欧盟如此焦虑

一只“北京鸭”,为何让欧盟如此焦虑

环球网资讯
2026-07-18 06:36:12
湖北一法院错拍浙江案外人资产“是个误会”:两审法院都裁定执行程序存瑕疵

湖北一法院错拍浙江案外人资产“是个误会”:两审法院都裁定执行程序存瑕疵

白鹿新闻
2026-07-18 17:03:09
“高考估分715查分299,女孩称试卷不是自己的”,警方:已被行拘

“高考估分715查分299,女孩称试卷不是自己的”,警方:已被行拘

南京择校
2026-07-18 12:18:29
西班牙主帅发布会遭狂嘘后质问:你们在干什么?我从小被教育要尊重

西班牙主帅发布会遭狂嘘后质问:你们在干什么?我从小被教育要尊重

热血体育社
2026-07-19 01:46:15
重磅:莫斯科遭受大规模攻击!乌克兰重创俄军物流中心

重磅:莫斯科遭受大规模攻击!乌克兰重创俄军物流中心

项鹏飞
2026-07-18 20:59:52
“网约车之王”广汽埃安暴雷,超21万辆车存在电芯隐患,中创新航177Ah电池陷质量争议

“网约车之王”广汽埃安暴雷,超21万辆车存在电芯隐患,中创新航177Ah电池陷质量争议

新浪财经
2026-07-17 20:46:32
给力!肺癌控制率达100%,70%明显缩小或消失,还可治疗多种肿瘤

给力!肺癌控制率达100%,70%明显缩小或消失,还可治疗多种肿瘤

华庭讲美食
2026-07-18 17:08:02
二胎、三胎催生无果,国家换新思路!马光远“新方案”得到支持

二胎、三胎催生无果,国家换新思路!马光远“新方案”得到支持

快乐彼岸
2026-07-18 19:01:46
自然资源部部署全国地质灾害风险隐患巡查排查

自然资源部部署全国地质灾害风险隐患巡查排查

界面新闻
2026-07-18 17:41:39
中国为何不举办世界杯?分析,有5大主要原因

中国为何不举办世界杯?分析,有5大主要原因

体育哲人
2026-07-18 21:50:20
河南一烤鸭店每天第一波客人竟是汪汪队,5只小狗街头自觉排队等投喂,陪伴到深夜12点闭店,老板已投喂流浪狗多年,网友:老顾客到齐了

河南一烤鸭店每天第一波客人竟是汪汪队,5只小狗街头自觉排队等投喂,陪伴到深夜12点闭店,老板已投喂流浪狗多年,网友:老顾客到齐了

极目新闻
2026-07-18 21:30:00
驿站老板好心帮忙,让朋友15岁儿子干零活,劳动监察部门:违规使用童工罚款5000元

驿站老板好心帮忙,让朋友15岁儿子干零活,劳动监察部门:违规使用童工罚款5000元

新快报新闻
2026-07-18 21:44:18
A股:股民要做好准备,不出意外,7月20日,下周一将上演熟悉剧情

A股:股民要做好准备,不出意外,7月20日,下周一将上演熟悉剧情

虎哥闲聊
2026-07-18 17:50:46
国际足联左右为难,季军赛若不取消,对梅西太不公正

国际足联左右为难,季军赛若不取消,对梅西太不公正

童叔不飙车
2026-07-18 23:57:32
印尼效应!津巴布韦:永久禁止锂精矿出口!中资占比90%!

印尼效应!津巴布韦:永久禁止锂精矿出口!中资占比90%!

比利
2026-07-18 10:32:20
年入百万补课老师吐实情:多数家长补课血汗钱,全都白白打水漂

年入百万补课老师吐实情:多数家长补课血汗钱,全都白白打水漂

鬼菜生活
2026-07-18 17:06:11
上海房价正式跌破5万

上海房价正式跌破5万

谭谈财经
2026-07-18 20:20:56
儿女全都不愿接班,85岁浙商无奈12.9亿卖掉自家上市公司

儿女全都不愿接班,85岁浙商无奈12.9亿卖掉自家上市公司

新浪财经
2026-07-18 19:55:51
两性心理学:敢和别人老婆“偷情”的男人,绝大多数都会有这两个“心理”,超准

两性心理学:敢和别人老婆“偷情”的男人,绝大多数都会有这两个“心理”,超准

心理观察局
2026-07-16 06:35:04
姆巴佩一脸茫然!法国队半场耻辱0-4:英格兰压着打 德尚脸色铁青

姆巴佩一脸茫然!法国队半场耻辱0-4:英格兰压着打 德尚脸色铁青

风过乡
2026-07-19 05:55:29
2026-07-19 06:23:00
我是一个养虾人
我是一个养虾人
有态度网友ytd
289文章数 59关注度
往期回顾 全部

科技要闻

WAIC2026看什么?这份"不迷路"攻略请收好

头条要闻

“黄总请你去包厢” “黄总”身份公布

头条要闻

“黄总请你去包厢” “黄总”身份公布

体育要闻

德尚是非典型法国人 14年执教留下丰厚遗产

娱乐要闻

大S给具俊晔留遗产是昏头?实际上她清醒得很

财经要闻

股民当街砍博主!韩国股市 终极大屠杀

汽车要闻

把中国超跑卖到英国,比亚迪正在被世界看见

态度原创

教育
时尚
本地
数码
艺术

教育要闻

江苏2026物理类录取线TOP40高校,南航南理生源被外省985争夺,考生不出省心态或在改变

钱没白花|| 用了6年、真正留下来的心头爱,这次有好价!

本地新闻

十年了,为什么鬼怪CP还能让人美美嗑上?

数码要闻

RTX 5060换芯不换性能!微星V1版用上5070核心:大芯片散热反而更好

艺术要闻

蒋校长和郭沫若同题“黄帝陵”,水平谁高谁低?

无障碍浏览 进入关怀版