with one click
tech-doc-style-chinese
// 在撰写、改写或审阅中文技术文档、文档首页、产品文案、界面文案、Markdown 文档或接口说明时使用。采用克制、准确、可扫读的中文技术写作风格:避免第二人称和宣传腔,统一使用直角引号,在可见正文中处理中文与英文或数字的留白,不改动代码字面量、JSON 键名、URL、API 路径等机器可读内容。如项目存在专属术语、版本展示或信息架构约定,再按需读取 references/Project-Overrides.md。
// 在撰写、改写或审阅中文技术文档、文档首页、产品文案、界面文案、Markdown 文档或接口说明时使用。采用克制、准确、可扫读的中文技术写作风格:避免第二人称和宣传腔,统一使用直角引号,在可见正文中处理中文与英文或数字的留白,不改动代码字面量、JSON 键名、URL、API 路径等机器可读内容。如项目存在专属术语、版本展示或信息架构约定,再按需读取 references/Project-Overrides.md。
[HINT] Download the complete skill directory including SKILL.md and all related files
| name | tech-doc-style-chinese |
| description | 在撰写、改写或审阅中文技术文档、文档首页、产品文案、界面文案、Markdown 文档或接口说明时使用。采用克制、准确、可扫读的中文技术写作风格:避免第二人称和宣传腔,统一使用直角引号,在可见正文中处理中文与英文或数字的留白,不改动代码字面量、JSON 键名、URL、API 路径等机器可读内容。如项目存在专属术语、版本展示或信息架构约定,再按需读取 references/Project-Overrides.md。 |
在以下任务中使用这份 Skill:
不要用这份 Skill 去改写代码字面量、JSON 键名、URL、API 路径、数据库字段名或其他机器可读标识符。
如果项目存在专属术语、版本展示、信息架构或品牌约定,再按需读取 references/Project-Overrides.md。
Hello、Hi 这类问候式开场默认避免以下高危黑话词,除非用户明确要求保留,或该词在当前语境中有严格业务定义:
赋能抓手闭环沉淀对齐对标拉通打通协同联动洞察赛道心智调性战役链路势能兜底以下中危词只有在语义明确时才使用:
场景生态体系路径触点卡点布局矩阵颗粒度复盘梳理输出提炼优先替换为更具体的表达:
赋能 -> 提供抓手 -> 关键措施闭环 -> 完整流程沉淀 -> 形成 / 积累对齐 -> 统一拉通 / 打通 -> 连接 / 贯通洞察 -> 分析结论兜底 -> 保障机制仅在以下情况允许保留黑话原词:
如果保留黑话原词,优先采用以下处理方式:
「」“”你、您、同学开发者、技术负责人、实施人员、业务负责人、产品经理在可见正文中,中文与可读的半角英文单词、英文缩写、独立数字和版本号之间保留空格,以提高可读性。
推荐写法:
获取批量 IDHTTP 请求版本 2.0AI 服务与 PM 协作读取系统日志以下内容不要机械加空格:
示例:
user_id 保持原样/api/example 保持原样statusCode 保持原样header_name 保持原样说明:
pangu.js 批量处理 Markdown 文档仅对可见正文中的自然语言短语做归一:
Id / id / ID -> IDhttp / Http / HTTP -> HTTPurl / URL / Url -> URLjson / JSON / Json -> JSONapi / Api / API -> APIai / Ai / AI -> AI以下清单用于补充高频技术术语,写法统一为 错写 -> 推荐。仅作用于可见正文,不作用于代码、路径、字段和配置项字面量。
java -> Javajavascript -> JavaScripttypescript -> TypeScriptJS / Js -> JavaScriptllm / Llm -> LLMaigc / Aigc -> AIGCrag / Rag -> RAGchatgpt / Chatgpt -> ChatGPTopenai api / OpenAI api -> OpenAI APIembeding -> embeddingfinetune / fine tune -> fine-tuning(如语义是训练过程,也可直接写 微调)python -> Pythongolang / go(指语言名) -> Gorust -> Rustkotlin -> Kotlinswift -> Swiftphp -> PHPruby -> Rubyscala -> Scaladart -> Dartsql -> SQLbash -> Bashpowershell -> PowerShellnodejs / node(指运行时或平台名) -> Node.jsdotnet -> .NETreactjs -> Reactvuejs -> Vuenextjs -> Next.jsnuxtjs -> Nuxtvitejs -> Vitetailwind -> Tailwind CSSnginx -> Nginxredis -> Redispostgres / postgresql -> PostgreSQLmysql -> MySQLmongodb -> MongoDBelasticsearch -> Elasticsearchkafka -> Kafkarabbitmq -> RabbitMQgithub -> GitHubgitlab -> GitLabdocker -> Dockerk8s(正式文案) -> Kuberneteshttps -> HTTPSgrpc -> gRPCgraphql -> GraphQLwebsocket -> WebSocketyaml -> YAMLxml -> XMLjwt -> JWToauth -> OAuth 2.0H5 -> HTML5(如语义是移动 Web 页面,优先直接写 移动 Web 页面)适用示例:
批量 id -> 批量 ID接口 url -> 接口 URL响应 json -> 响应 JSON启用 rag -> 启用 RAG接入 chatgpt -> 接入 ChatGPT调用 openai api -> 调用 OpenAI API以下内容不要改写:
user_id示例:
从这里开始核对调用规则初步了解避免:
阅读平台介绍查看认证规则当标题已经表达同一信息时,不要在行动按钮文案里重复。
以下模板是通用写法参考,不是强制结构。项目如有专属信息架构,优先服从项目覆盖规则。
首段通常回答三件事:
段落保持紧凑,不要叠加口号式表达。
第一段通常说明:
按业务用途组织,而不是按接口清单平铺。
可参考的顺序:
常见误译词表:
Success
成功已完成、已处理、请求已受理Invalid
非法无效、格式无效、有误、校验未通过Available
可用已开通、可获取、可访问、可使用Unsupported
暂不支持、不支持该类型、当前不支持Pending
待处理、处理中、待确认Expired
已过期Missing
缺少、未提供Denied
被拒绝、不予通过Forbidden
禁止无权限访问、当前不允许访问Not Found
未找到对应内容、未找到对应数据Accepted
已接受已受理、已接收,等待处理Completed
已完成Failed
失败处理失败Conflict
冲突状态冲突、资源状态不一致、请求与当前状态冲突Unauthorized
未授权未登录、认证未通过、缺少认证信息Bad Request
错误请求请求参数有误、请求格式有误Timeout
超时请求超时、处理超时当同一标题下出现 4 个及以上并列项时:
参数 / 是否必填 / 说明 表优先改卡片式行布局用于排查词义错位、数量逻辑错误和表达歧义。优先写成「具体、可验证、不歧义」的表达。
出生于技术团队 -> 出身于技术团队(出生 仅用于生理出生)阀值 -> 阈值请先登陆系统 -> 请先登录系统(登陆 多用于登岸)截止 4 月 12 日 -> 截至 2026 年 4 月 12 日(时间范围优先用 截至,并给完整日期)布署到生产环境 -> 部署到生产环境配制服务器参数 -> 配置服务器参数起用该功能 -> 启用该功能反回结果 -> 返回结果回朔历史版本 -> 回溯历史版本标示字段 -> 标识字段(指 ID、标签、标记物时)帐户余额 -> 账户余额(金融语境)帐号登录 -> 账号登录(平台用户语境,建议统一)搜寻日志 -> 搜索日志即时通信 -> 实时通信(系统能力描述语境)做为默认配置 -> 作为默认配置系统发布到生产环境 -> 部署到生产环境 / 发布新版本(区分 部署 与 发布)完成授权(语义为身份校验) -> 完成认证(认证 = 确认身份,授权 = 授予权限)缩小了 3 倍 -> 缩小到原来的 1/3 / 减少了 2/3增长到 30%(原来 20%) -> 从 20% 提高到 30% / 相对增长 50%转化率提升了 5%(20% -> 25%) -> 提升了 5 个百分点 / 相对提升 25%翻了 1 倍 -> 变为原来的 2 倍不超过 100 以上 -> 不超过 100预计大约在 3 点左右 -> 预计 3 点 / 预计 3 点左右是否可以 A 或者 B -> 可以 A 或者 B / 是否可以 A尽快处理 -> 30 分钟内处理(将模糊词改为明确时限)使用提示工程学优化输出 -> 使用提示工程优化输出模型出现幻听 -> 模型出现幻觉交付前检查:
你、您、同学“”改写前:
阅读平台介绍
改写后:
从这里开始
改写前:
本页适合第一次进入文档中心的业务负责人、产品经理、技术负责人和实施同学。
改写后:
本页适合首次访问文档中心的业务负责人、产品经理、技术负责人和实施人员。
改写前:
获取数据批量ID
改写后:
获取数据批量 ID
改写前:
集中说明请求头、签名算法、时间戳与错误码,适合发起请求前逐项核对。
改写后:
集中说明通用技术约定,适合发起请求前快速逐项核对。