中文文档

文档 社区

技能解读

当前原文的自动摘译,尚未人工审校。

概述

中文技术文档最常见的问题不是内容不够,而是读起来别扭——中英文挤在一起没有空格、全角半角混用、一股机翻味。本技能提供一套完整的中文技术文档写作规范,让你的文档专业、好读、不出戏。 核心原则: 排版服务于阅读体验,规范服务于一致性,内容服务于读者。 参考标准: 中文文案排版指北

空格

中英文之间加空格: 中文与数字之间加空格: 数字与单位之间加空格: 例外:度数、百分比等不加空格: 链接前后加空格:

标点符号

中文语境使用全角标点: 全角标点与英文/数字之间不加空格: 括号的使用: 引号的使用:

术语处理原则

保留英文的情况: 专有名词:React、Kubernetes、Redis、MySQL 行业通用缩写:API、SDK、CLI、ORM、CI/CD 命令和代码:npm install、git commit 协议和标准:HTTP、TCP/IP、JSON、REST

首次出现标注翻译

技术术语首次出现时,标注中英对照:

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
文档
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@jnMetaCode · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
需简单配置
是否需要外部接口密钥
需要 · Vendor-specific
兼容的系统
macOS · Linux · Windows
运行环境要求
Node.js >=20
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
网络行为
允许外网请求
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

输出预览 chinese-documentation.preview
{
  "product_id": "prod_abc123",
  "quantity": 2,
  "address_id": "addr_xyz789",
  "coupon_code": "SUMMER2024"
}
\

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。