教程读起来不顺
教程应围绕读者已有知识和准备完成的操作展开。将标题、步骤、样例与前提条件逐项对照用户任务,而不是作者的实施历史。修正缺失条件和无法衔接的步骤,让读者能够从一个动作顺利推进到下一个动作。
使用 Vercel Labs 的 Writing Guidelines,依据 Vercel 写作手册审查已有文档与文案。指定文件、读者和用途,获取可定位的语言与结构反馈,再结合自己的术语、品牌语气和文档要求,选择适合采纳的修改。
提供原稿、目标读者及文字需要说明的操作,将审阅集中到术语、前提和样例。请求中的表达调整需要保留已确认的技术含义,避免用泛化文风偏好替换真正有用的细节。
请求可预览和复制,不会从此处自动发送。
参考来源: Writing Guidelines https://github.com/vercel-labs/agent-skills/blob/main/skills/writing-guidelines/SKILL.md 先阅读原始说明并核对当前环境与依赖。需要安装或连接新工具时,先提出方案。 我的任务: 按当前 Vercel 写作规范审查这些入门文档,给出 file:line 问题,不要改写事实陈述。 期望交付: 文件与行号编辑意见,分别说明表达问题和仍需确认的事实。
Writing Guidelines 是 Vercel Labs 面向已有文档与文案发布的审查 Skill。它先获取当前 Vercel 写作手册,再读取指定文件,并以文件和行号给出简洁反馈,让 Agent 将编辑意见对应到具体文本。它适合有明确读者与用途的教程、参考文档和更新说明,帮助检查语言与结构是否服务于阅读任务。写作手册体现的是 Vercel 的表达偏好,其他团队应结合自身品牌语气、术语和文档规范判断建议。原始流程的重点是审查;生成新内容或直接修改文件,需要另外明确任务范围。
教程、API 参考和更新说明需要回答不同的读者问题。了解 Writing Guidelines 如何组织前提条件、参数限制和已验证的用户影响,避免用实施记录或空泛宣传代替有效说明。
教程应围绕读者已有知识和准备完成的操作展开。将标题、步骤、样例与前提条件逐项对照用户任务,而不是作者的实施历史。修正缺失条件和无法衔接的步骤,让读者能够从一个动作顺利推进到下一个动作。
API 参考需要清楚的命名、参数说明,以及符合已确认限制的样例。审阅代码格式时,同时检查条件与注意事项的位置,让它们靠近真正受影响的操作。使用者应在遇到可避免的错误之前,就能找到必要的使用要求。
更新说明应讲清已验证的行为变化及其对用户的影响。将草稿与发布差异对照,改写空泛形容和掩盖实际改动的表达。尚未核实的说法单独保留,避免对外说明承诺证据无法支持的改进。
教程、API 参考和更新说明,可能用相互冲突的词描述同一功能。对照已确认名称与行为提出修订,让读者理解保持一致,同时保留条件或含义上的真实差别。文字调整不应静默改变代码命名,也不应为了统一表达而消除产品概念区别。
读者要完成的操作决定文字怎样组织,原稿和技术条件则限定哪些内容不能随意变化。对照规范修改具体段落时,术语、前提和样例含义仍需与已确认事实保持一致。
提供文档或文件路径模式。说明目标读者、文档用途,以及需要保留的术语。
让 Agent 获取 Vercel 当前写作手册并检查所选文本。要求反馈简洁,并附文件与行号。
修改前先与自己的文风要求比较。完成后重读相关段落,核对含义、准确性与一致性。
查看其他 Skill 指南,并在使用前核对原始来源。