架构决策记录 ADR
写作与编辑半年前为什么选这套方案没人记得,只留下一个不敢动的模块
我们要记录这个决策:[决策内容与背景]。请写成 ADR:标题与日期、当时的问题与约束、考虑过的三个方案及各自代价、最终选…
AI / 写作与编辑
把草稿改顺、把话说清楚,而不是让 AI 替你写
9 / 9
半年前为什么选这套方案没人记得,只留下一个不敢动的模块
我们要记录这个决策:[决策内容与背景]。请写成 ADR:标题与日期、当时的问题与约束、考虑过的三个方案及各自代价、最终选…
新人入职一周还在问「这个服务是干什么的」,缺的是一张全景图
我们系统包含 [服务或模块清单]。请写一份新人上手文档:一张文字版全景图(谁调用谁、数据往哪流)、每个模块一句话职责、本…
字段名只有开发看得懂,取数的人每次都要去问一遍口径
这是我们的表结构:[表名与字段列表]。请写成数据字典:字段中文名、业务含义、类型与单位、取值范围或枚举含义、是否可空、来…
半夜告警响了,值班的人第一件事是翻聊天记录找上次怎么处理
这个告警:[告警名称与触发条件]。请写一份处置手册:这条告警代表什么、先确认哪三个指标、五分钟内判断影响面的方法、可立即…
上线文档只写「执行部署脚本」,出问题时没人知道怎么退回去
本次发布内容:[变更项与依赖]。请写发布手册:发布前检查项(数据备份、开关状态、依赖版本)、分步发布命令与每步的验证方法…
评审会上被问到没准备的细节,方案就容易否掉,问题在文档结构
请把 [方案想法] 写成评审文档:要解决的问题与不解决的后果、约束条件、两个以上候选方案与取舍表、推荐方案的模块划分与关…
按功能罗列的手册没人读,用户是带着一件要做的事来翻的
这是现有产品手册的目录:[按功能排列的章节]。请改写成任务导向结构:按用户想完成的事分组(如「导出上月数据」「给同事开权…
装完打不开是最容易流失用户的一步,指南要覆盖失败而不只是成功
产品是 [产品名],运行环境为 [系统与版本要求]。请写安装与初始化指南:环境检查清单、安装步骤与预期输出、首次启动必须…
排查文档写成一大段,用户读到第三行就放弃,改成一次一个判断
用户反馈的问题是 [现象描述]。请写成排查决策树:从最容易验证的一步开始,每个节点是一个是非判断或一个可执行的检查动作,…
客服每天回答同样十个问题,FAQ 却一直没人整理
这是最近 [时间范围] 的客服工单摘要:[工单主题与频次]。请整理成 FAQ:按提问频次排序,每个问题用用户的原话做标题…
每篇文章结构都不一样,用户读完还是不确定自己有没有做对
请按统一骨架写一篇帮助中心文章,主题是 [功能或问题]。结构固定为:一句话说明能解决什么、适用条件、编号步骤(每步一个动…
截图截了整屏,用户找不到该点哪里,说明文字也没说清
这篇操作指南配有 [张数] 张截图。请为每张写:图注(这张图在说明哪个动作)、需要框选或高亮的区域、编号标注对应的步骤、…
「操作失败,请稍后重试」这样的提示,用户重试十次还是失败
现有报错文案:[错误提示列表与触发场景]。请逐条改写:说清发生了什么(不暴露内部实现)、可能的原因(按概率排序)、用户现…
新账号进来一片空白,用户不知道下一步该点什么
这个页面在用户没有数据时会显示空白,场景包括 [首次使用/筛选无结果/无权限/加载失败]。请为每种场景写文案:一句说明当…
谁能看什么全靠口头传,新客户开通时总要来回确认
我们的角色有 [角色列表],涉及的对象有 [数据对象]。请输出权限说明表:角色 × 对象 × 可执行动作,标出哪些权限默…
套餐说明写得像合同,用户算不出自己这个月要付多少
我们的套餐与计费规则是:[套餐、额度、超量单价、计费周期]。请改写成用户能自己算的说明:一个具体用量的算例(含超量)、哪…
用户问「数据能不能带走、删了是不是真没了」,答案得写在明面上
请针对 [产品名] 写一篇数据导出与删除说明:可导出的数据范围与格式、导出所需时间与获取方式、删除账号后哪些数据立即消失…
只用键盘的用户卡在某一步,文档里却完全没提
请为 [功能或页面] 写键盘操作与无障碍说明:完整快捷键表(含冲突与自定义)、不用鼠标完成主流程的步骤、焦点顺序与跳转、…
用户在手机上找不到网页版有的按钮,客服也说不清为什么
我们的产品有 [端:网页/iOS/安卓/桌面客户端]。请整理功能差异表:功能 × 端 × 是否支持 × 差异说明 × 替…
发布说明写成一串提交记录,用户看不出这次更新跟自己有什么关系
本次版本的改动清单:[改动项与技术描述]。请改写成用户视角的发布说明:按「新增/改进/修复」分组,每条用用户能感知的结果…
每次更新日志格式都不一样,回查某次改动像在做考古
这是我们的历史更新记录:[原始记录]。请整理成规范 changelog:版本号与日期、分类固定为新增/变更/废弃/移除/…
接口字段悄悄改了名,调用方第二天集体报错
我们将在 [日期] 做出破坏性变更:[具体变更]。请写公告:变更内容与原因、受影响的调用方如何自查、迁移步骤与代码示例、…
一个功能要停,用户第一反应是「我的数据怎么办」
我们计划在 [日期] 下线 [功能名]。请写通知:下线的原因(克制、不甩锅)、受影响的用户与数据范围、数据导出或迁移的具…
故障还在查,先发一条不猜原因、只讲影响和下一步的更新
当前故障情况:[影响的功能、开始时间、已知现象]。请写一条状态页更新:受影响范围与用户会看到什么、我们已确认与尚未确认的…
内部复盘满篇是服务名,客户只想知道影响、原因和以后怎么防
本次故障的内部记录:[时间线、根因、影响面、处理过程]。请写成对外复盘:发生了什么(按时间线,用客户能懂的话)、影响了谁…
半夜维护也要提前说,用户第二天发现数据没同步会以为丢了
我们计划在 [时间窗口] 进行维护,影响 [功能范围]。请写通知:维护起止时间(含时区)、期间哪些功能不可用、哪些仍然可…
用户报名内测后不知道会经历什么,遇到问题就当成正式版故障
我们要邀请 [用户群] 参与 [功能] 的灰度测试。请写说明:这个版本和正式版的差别、可能遇到的问题与已知缺陷清单、如何…
新人上岗第一周的问题都差不多,但答案散在十几个文档里
我们是 [产品] 的客服团队,新人最常问这些:[问题列表]。请整理成内部 FAQ:每个问题给标准答案、判断依据、可以承诺…
同一个问题有三篇文章,内容还不一致,用户不知道信哪篇
这几篇知识库文章讲的可能是同一件事:[标题与摘要]。请判断是否真的重复,若重复则合并成一篇:保留最准确的说法、列出各篇之…
文档库里一半内容已经不准,没人敢删,也没人敢信
这是我们文档库的清单:[文档标题、最后更新日期、访问量]。请给出清理方案:按「高访问且过期」「低访问且过期」「无人维护」…
三个人写同一份文档,语气、称谓、步骤格式全都不一样
请为 [团队名] 写一份文档风格指南:人称与称谓、句子长度上限、步骤的写法(动词开头、一步一个动作)、标题层级规则、代码…
文档越写越多,新人找不到入口,老员工靠收藏夹硬撑
现有文档目录结构:[目录树与每篇的用途]。请重新设计信息架构:按用户任务而不是按团队划分顶层、每层不超过七项、给出每篇的…
功能演示只活在一次会议录屏里,新人培训又要重讲一遍
这是一段功能演示的录屏转写或口述记录:[转写内容]。请整理成可复用的操作文档:先列操作路径,再把口述里的经验判断提炼成注…
销售在客户面前解释不清技术优势,只能说「我们的架构很先进」
需要向销售解释这个概念:[技术概念]。请写一段说明:它解决什么客户痛点、用生活化的类比说明原理、与竞品常见做法的差别、客…
测试拿着需求文档不知道从哪下手,漏测的总是异常路径
这是需求文档中的 [功能说明与验收标准]。请转成测试点清单:正常路径、边界值、异常输入、权限与并发、状态流转、数据一致性…
工艺参数改了只通知到班长,第二天三个班次做出来的活儿都不一样
我们要变更 [工序名] 的 [具体参数或物料],生效时间 [日期与班次]。请写变更通知单:变更内容与原因、受影响的产品型…
使用说明把禁忌藏在段落里,护士忙起来根本不会读到
这是 [器械名] 的使用说明草稿:[原文]。请重排:适应症与禁忌症前置并单列、操作步骤按编号排列、报警与异常处置独立成节…
风险揭示写得像法律条文,客户直接划到底部点同意
这是某理财产品的风险揭示内容:[原文要点]。请改写成客户真能读懂的说明:最坏情况下可能损失什么、哪些情况会导致亏损、费用…
办事指南按部门写,居民只想知道带什么、去哪、多久办完
这是一项政务服务:[事项名称与现行说明]。请改写成居民视角的办事指南:谁能办、要带什么材料(区分原件与复印件、可否线上提…
学生照着实验指导书做不出来,因为省略了失败和观察记录的部分
这是 [课程名] 的实验:[实验目的与现有步骤]。请改写指导书:实验前要预习的概念、器材与安全注意事项、按编号的操作步骤…
README 开头就是架构图,路过的人三秒内没搞懂这是干什么的
项目是 [项目名],解决 [问题],主要用户是 [开发者类型]。请写 README:一句话说明它是什么、三十秒能跑起来的…
步骤编号跳号、截图是旧版、链接打不开,这些错最能毁掉信任
这是准备发布的文档:[文档全文]。请做发布前校对:步骤编号与截图标注是否对应、术语与产品内实际文案是否一致、版本号与日期…