• 回答数

    0

  • 浏览数

    9

  • 收藏数

    0

作者:mary 发表于 10 小时前
跳转到指定楼层
大家好,最近我在团队内部推行了一套新的技术方案,主要是利用大模型来辅助撰写技术文档和 API 说明。想把这个过程分享一下,看看大家有没有类似的经验或者更好的用法。

之前写文档是最头疼的环节,尤其是 API 接口变更时,参数说明、示例代码、错误码定义需要反复校对,很容易出现前后不一致的情况。现在我的流程大概是这样的:首先把原始的 Swagger/YApi 定义导出为 Markdown 草稿;然后喂给 AI,让它根据上下文补充“背景说明”和“典型使用场景”,同时自动检查参数描述的准确性;最后人工审核一遍逻辑和敏感信息。

这个过程大概能节省 40% 左右的初稿时间。不过这里有个坑要注意,AI 生成的示例代码有时会为了“看起来正确”而编造不存在的库或方法,所以代码部分必须人工复核,不能全信。

另外,大家觉得在技术论坛里,这种“AI 辅助写作”的边界在哪里?比如,直接让 AI 润色帖子内容算不算投机?还是说只要事实准确、逻辑清晰就可以接受?

欢迎评论区讨论,或者分享你们用的 Prompt 技巧,互相学习一下。
分享:
回复

使用道具

成为第一个回答人

高级模式 评论
您需要登录后才可以回帖 登录 | 立即注册
⚠️

AI客服助手

⇲ ×
AI
您好!我是AI客服助手,有什么可以帮助您的吗?

请先登录后使用AI客服助手

立即登录
内容由非常AI大模型生成,仅供参考,相关风险需自行承担。

赚钱

会员VIP

留言板

商务合作

联系电话:17308937318

QQ邮箱

QQ:118275

邮箱:118275@qq.com

友情链接