Token导航 LogoToken导航TokenDH.com
研究检索需要联网github未标认证来源可访问许可证需确认审计通过

tech-doc-style-chinese技术文档风格中文

Agent Skill

用于辅助文档、README、Markdown、说明文和内容稿件的整理与改写。它适合让 Agent 提炼结构、补齐章节、统一术语、检查链接或把零散材料整理成可读文档。使用时应保留项目已有事实、命令和路径,不要把未确认的信息写成确定结论;涉及对外文案时,还需要控制语气,避免过度营销或夸大能力。

总安装

783

周安装

32

GitHub Stars

348

下载量

253
CodexClaudeCursorGemini CLI

安装说明

本站只整理中文说明和来源信息,不托管安装包,也不代用户安装。

GitHub

来源数

2

许可证

unknown

最后核验

2026-05-01

来源状态

来源可访问

安装方式

通过对话安装

复制提示词发给支持本地命令或 Skills 的 AI 助手,先确认命令和权限,再让它执行。

请帮我安装这个 Agent Skill:tech-doc-style-chinese(技术文档风格中文)
来源仓库:https://github.com/fenng/tech-doc-style-chinese
仓库路径:skills/tech-doc-style-chinese
安装命令:
npx skills add https://github.com/fenng/tech-doc-style-chinese --skill tech-doc-style-chinese
安装前请先检查当前环境是否支持对应 CLI,并向我确认将要执行的命令、安装目录、联网范围和文件读写权限;确认后再执行。

命令行安装

复制命令到本机终端执行。该命令会通过 npx skills 从第三方来源获取 Skill;本站只展示命令,不托管安装包,也不自动执行。

skills.shnpx skills
npx skills add https://github.com/fenng/tech-doc-style-chinese --skill tech-doc-style-chinese

简介

用于辅助文档和 Markdown 稿件整理。

  • 适合提炼结构、统一术语或补齐章节。
  • 应保留项目已有事实和路径信息。tech-doc-style-chinese 属于研究检索类 Skill,可作为该场景下的辅助能力补充。
  • 涉及对外文案时需控制语气避免夸大。
  • 不要把未确认信息写成确定结论。适用宿主包括 Codex、Claude、Cursor、Gemini CLI,接入前应确认版本、权限和运行环境要求。

SKILL.md

中文技术文档与产品文案排版规范

在以下任务中使用这份 Skill:

  • 文档首页、落地页、首屏文案
  • 接口文档、参数说明、常见问题、更新日志
  • 产品能力介绍、解决方案页、能力说明页
  • 界面文案、按钮文案、导航标签、提示信息

不要用这份 Skill 去改写代码字面量、JSON 键名、URL、API 路径、数据库字段名或其他机器可读标识符。

如果项目存在专属术语、版本展示、信息架构或品牌约定,再按需读取 references/Project-Overrides.md

目标

  • 准确先于修辞
  • 清晰先于热闹
  • 导航感先于宣传感
  • 可扫读先于堆砌解释
  • 以信息架构和内容组织引导阅读,而不是依赖修辞或口号式表达

语气

  • 使用克制、直接、可执行的中文
  • 以说明、界定、引导为主,不用夸张宣传语
  • 避免「领先」「强大」「重磅」「颠覆」「震惊」「炸裂」「恭喜」等空泛形容
  • 优先陈述「是什么、适用于什么、下一步看哪里」
  • 不用第二人称
  • 避免问候式开场、平台营销话术和口号式抽象表达
  • 避免使用 HelloHi 这类问候式开场

黑话短名单

默认避免以下高危黑话词,除非用户明确要求保留,或该词在当前语境中有严格业务定义:

  • 赋能
  • 抓手
  • 闭环
  • 沉淀
  • 对齐
  • 对标
  • 拉通
  • 打通
  • 协同
  • 联动
  • 洞察
  • 赛道
  • 心智
  • 调性
  • 战役
  • 链路
  • 势能
  • 兜底

以下中危词只有在语义明确时才使用:

  • 场景
  • 生态
  • 体系
  • 路径
  • 触点
  • 卡点
  • 布局
  • 矩阵
  • 颗粒度
  • 复盘
  • 梳理
  • 输出
  • 提炼

优先替换为更具体的表达:

  • 赋能 -> 提供
  • 抓手 -> 关键措施
  • 闭环 -> 完整流程
  • 沉淀 -> 形成 / 积累
  • 对齐 -> 统一
  • 拉通 / 打通 -> 连接 / 贯通
  • 洞察 -> 分析结论
  • 兜底 -> 保障机制

仅在以下情况允许保留黑话原词:

  • 用户明确要求保留原词
  • 正在引用原始材料、访谈、方案原文或外部文档
  • 该词在特定行业语境里有固定含义,替换后会损失准确性
  • 该词是产品名称、功能名称、方法论名称或组织内部正式术语

如果保留黑话原词,优先采用以下处理方式:

  • 首次出现时给出更具体解释
  • 在同一句或下一句说明它实际指什么
  • 避免连续堆叠多个黑话词

强制规则

1. 标点

  • 中文引号统一使用直角引号:「」
  • 不使用中文双引号:“”
  • 正文中避免连续使用多个感叹号、省略号、宣传口号式断句
  • 避免使用感叹号

2. 称呼与受众

  • 不使用:同学
  • 根据语境替换为:开发者技术负责人实施人员业务负责人产品经理
  • 如无必要,不直接点名读者,用无主句或说明句即可

3. 中文与英文、数字之间的留白

在可见正文中,中文与可读的半角英文单词、英文缩写、独立数字和版本号之间保留空格,以提高可读性。

推荐写法:

  • 获取批量 ID
  • HTTP 请求
  • 版本 2.0
  • AI 服务
  • 与 PM 协作
  • 读取系统日志

以下内容不要机械加空格:

  • 行内代码和代码块
  • JSON 键名
  • URL
  • API 路径
  • 数据库字段名
  • 表头中直接镜像接口字段定义的标签
  • 用户明确指定的拼写或大小写

示例:

  • user_id 保持原样
  • /api/example 保持原样
  • statusCode 保持原样
  • header_name 保持原样

说明:

  • 将中西文留白视为最终校对规则,而不是机械替换规则
  • 不直接使用 pangu.js 批量处理 Markdown 文档
  • 如遇字段名、协议名、路径或术语边界不清的情况,优先保持原样并人工判断

4. 可见术语的大小写归一

仅对可见正文中的自然语言短语做归一:

  • Id / id / ID -> ID
  • http / Http / HTTP -> HTTP
  • url / URL / Url -> URL
  • json / JSON / Json -> JSON
  • api / Api / API -> API
  • ai / Ai / AI -> AI

术语大小写归一扩展清单(高频)

以下清单用于补充高频技术术语,写法统一为 错写 -> 推荐。仅作用于可见正文,不作用于代码、路径、字段和配置项字面量。

  • java -> Java
  • javascript -> JavaScript
  • typescript -> TypeScript
  • JS / Js -> JavaScript
  • llm / Llm -> LLM
  • aigc / Aigc -> AIGC
  • rag / Rag -> RAG
  • chatgpt / Chatgpt -> ChatGPT
  • openai api / OpenAI api -> OpenAI API
  • embeding -> embedding
  • finetune / fine tune -> fine-tuning(如语义是训练过程,也可直接写 微调
  • python -> Python
  • golang / go(指语言名) -> Go
  • rust -> Rust
  • kotlin -> Kotlin
  • swift -> Swift
  • php -> PHP
  • ruby -> Ruby
  • scala -> Scala
  • dart -> Dart
  • sql -> SQL
  • bash -> Bash
  • powershell -> PowerShell
  • nodejs / node(指运行时或平台名) -> Node.js
  • dotnet -> .NET
  • reactjs -> React
  • vuejs -> Vue
  • nextjs -> Next.js
  • nuxtjs -> Nuxt
  • vitejs -> Vite
  • tailwind -> Tailwind CSS
  • nginx -> Nginx
  • redis -> Redis
  • postgres / postgresql -> PostgreSQL
  • mysql -> MySQL
  • mongodb -> MongoDB
  • elasticsearch -> Elasticsearch
  • kafka -> Kafka
  • rabbitmq -> RabbitMQ
  • github -> GitHub
  • gitlab -> GitLab
  • docker -> Docker
  • k8s(正式文案) -> Kubernetes
  • https -> HTTPS
  • grpc -> gRPC
  • graphql -> GraphQL
  • websocket -> WebSocket
  • yaml -> YAML
  • xml -> XML
  • jwt -> JWT
  • oauth -> OAuth 2.0
  • H5 -> HTML5(如语义是移动 Web 页面,优先直接写 移动 Web 页面

适用示例:

  • 批量 id -> 批量 ID
  • 接口 url -> 接口 URL
  • 响应 json -> 响应 JSON
  • 启用 rag -> 启用 RAG
  • 接入 chatgpt -> 接入 ChatGPT
  • 调用 openai api -> 调用 OpenAI API

以下内容不要改写:

  • 机器可读标识符
  • 字段化标签,如 user_id
  • 直接镜像接口定义的表头
  • 用户明确指定的大小写

5. 行动按钮文案

  • 按钮文案应体现下一步动作,避免与标题重复
  • 优先使用「动作 + 结果」或「动作 + 目标」

示例:

  • 从这里开始
  • 核对调用规则
  • 初步了解

避免:

  • 阅读平台介绍
  • 查看认证规则

当标题已经表达同一信息时,不要在行动按钮文案里重复。

常见内容类型模板

以下模板是通用写法参考,不是强制结构。项目如有专属信息架构,优先服从项目覆盖规则。

入口页或总览页

首段通常回答三件事:

  • 覆盖什么
  • 适合谁使用
  • 从哪里开始读

段落保持紧凑,不要叠加口号式表达。

介绍页

第一段通常说明:

  • 这页给谁看
  • 这页解决什么问题
  • 建议接着读哪里

解决方案页

按业务用途组织,而不是按接口清单平铺。

可参考的顺序:

  1. 适用场景
  2. 典型问题
  3. 推荐方案
  4. 推荐调用顺序
  5. 实施建议
  6. 能力边界

接口说明页

  • 请求方法行放进代码块,不要裸露在正文里
  • 参数说明尽量一列一义,不写含混描述
  • 错误码文案要统一口径
  • 不要机械直译常见英文状态词和错误词

常见误译词表:

  • Success

- 不默认写成 成功 - 按语义选择:已完成已处理请求已受理

  • Invalid

- 不翻译成 非法 - 按语义选择:无效格式无效有误校验未通过

  • Available

- 不机械翻译成 可用 - 按语义选择:已开通可获取可访问可使用

  • Unsupported

- 优先翻译为:暂不支持不支持该类型当前不支持

  • Pending

- 优先翻译为:待处理处理中待确认

  • Expired

- 优先翻译为:已过期

  • Missing

- 优先翻译为:缺少未提供

  • Denied

- 优先翻译为:被拒绝不予通过

  • Forbidden

- 不直接翻译成 禁止 - 按语义选择:无权限访问当前不允许访问

  • Not Found

- 优先翻译为:未找到对应内容未找到对应数据

  • Accepted

- 不机械翻译成 已接受 - 按语义选择:已受理已接收,等待处理

  • Completed

- 优先翻译为:已完成

  • Failed

- 优先翻译为:失败 - 如上下文更偏流程处理,可用:处理失败

  • Conflict

- 不机械翻译成 冲突 - 按语义选择:状态冲突资源状态不一致请求与当前状态冲突

  • Unauthorized

- 不翻译成 未授权 - 优先翻译为:未登录认证未通过缺少认证信息

  • Bad Request

- 不机械翻译成 错误请求 - 优先翻译为:请求参数有误请求格式有误

  • Timeout

- 优先翻译为:超时 - 如需更完整,可写为:请求超时处理超时

常见问题与排查页

  • 先给判断路径,再给例外
  • 优先说明「先查什么」,而不是只罗列概念
  • 错误排查文本要偏操作性,不要写成泛泛说明

排版与结构规则

  • 一个段落只承载一个主要信息点
  • 长句可以保留,但避免连续堆叠两个以上长句
  • 列表项要平行,不要有的写定义、有的写宣传、有的写结论
  • 标题要能反映用途,不要只写抽象名词

当同一标题下出现 4 个及以上并列项时:

  • 统一命名结构
  • 统一句式
  • 统一信息密度

界面文案规则

  • 按钮文案短,不解释背景
  • 卡片描述补信息,不重复标题
  • 导航标题偏名词
  • 行动文案偏动作

移动端可读性规则

  • 三列表参数表在移动端不应靠缩字硬挤
  • 常见 参数 / 是否必填 / 说明 表优先改卡片式行布局
  • 真正宽表再使用横向滚动

编辑流程

  1. 先判断内容类型。 例如:入口页、介绍页、解决方案页、接口说明页、常见问题、界面文案。
  2. 先去重复。 如果标题、正文和行动按钮文案在表达同一件事,优先重写行动按钮文案。
  3. 应用强制规则。 统一标点、称呼、留白和常见误译词。
  4. 再收句子。 只保留准确阅读和下一步导航所必需的信息。
  5. 最后通读。 检查语气、术语、留白、标题和扫读节奏。

中文易错表达清单

用于排查词义错位、数量逻辑错误和表达歧义。优先写成「具体、可验证、不歧义」的表达。

  • 出生于技术团队 -> 出身于技术团队出生 仅用于生理出生)
  • 阀值 -> 阈值
  • 请先登陆系统 -> 请先登录系统登陆 多用于登岸)
  • 截止 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 分钟内处理(将模糊词改为明确时限)
  • 使用提示工程学优化输出 -> 使用提示工程优化输出
  • 模型出现幻听 -> 模型出现幻觉

最终检查清单

交付前检查:

  • 是否出现 同学
  • 是否出现中文双引号 “”
  • 中文与英文、数字之间是否需要留白
  • 文案是否重复标题
  • 行动按钮文案是否与标题重复
  • 是否存在过强的宣传口吻
  • 文案是否便于扫读

改写示例

示例 1

改写前:

阅读平台介绍

改写后:

从这里开始

示例 2

改写前:

本页适合第一次进入文档中心的业务负责人、产品经理、技术负责人和实施同学。

改写后:

本页适合首次访问文档中心的业务负责人、产品经理、技术负责人和实施人员。

示例 3

改写前:

获取数据批量ID

改写后:

获取数据批量 ID

示例 4

改写前:

集中说明请求头、签名算法、时间戳与错误码,适合发起请求前逐项核对。

改写后:

集中说明通用技术约定,适合发起请求前快速逐项核对。

适合场景

01

用户想查找某类 Agent Skill 时

02

需要根据任务场景推荐可安装能力包时

03

需要对比不同来源的安装命令和来源信息时

能力概览

能力 1

按任务关键词查找相关 Skills

能力 2

展示可复制的安装命令

能力 3

保留来源站点、仓库和原始说明,方便继续核验

能力 4

展示第三方安全扫描或审计结果

安装后应在对应宿主中按原始 README 的触发条件使用;具体调用方式请以来源页面和 README 为准。

平台分布

Codex

35.11%
按下载量换算89

Claude

26.8%
按下载量换算68

Cursor

19.34%
按下载量换算49

Gemini CLI

8.9%
按下载量换算23

安全审计

Gen Agent Trust Hub

通过

Socket

通过

Snyk

通过

权限和风险

需要联网

该 Skill 可能需要联网访问来源站点、仓库或外部 API;具体网络访问范围需要结合源码和 README 复核。

安装前确认

本站仅展示第三方公开信息,不托管安装包,不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。当前只有一个来源,正式发布前建议补源仓库或其他目录站核验。

来源信息

继续浏览同类 Skills