Tech Doc Style Chinese

# 中文技术文档与产品文案规范

这是一份面向中文技术文档、产品文案和界面文案的写作 Skill。正式、可安装的规则入口是 [SKILL.md](SKILL.md)；本页只说明设计目标和内容结构，不复制完整规则。

## 目标

- 准确先于修辞
- 清晰先于热闹
- 事实保真先于表达优化
- 可执行先于抽象概括
- 可扫读先于堆砌解释

## 适用内容

- 文档首页和产品介绍
- API 文档、参数说明和错误码
- 操作手册、故障排查和运维 Runbook
- 常见问题、更新日志和解决方案页
- 按钮、导航、状态和提示信息

代码字面量、JSON 键名、URL、API 路径、数据库字段、命令和配置项不属于自然语言改写范围。

## 最重要的边界

文案优化不能改变事实。不得自行增加原文没有的：

- 日期和年份
- 数字和单位
- 处理期限和 SLA
- 产品能力
- 前置条件和因果关系
- 确定性结论

资料不足时保留原意，或明确标记待确认。

## 内容结构

核心入口 [SKILL.md](SKILL.md) 负责：

- 规则优先级
- 事实保真
- 撰写、改写、校对和审阅流程
- 核心语义、结构和语气规则
- 按内容类型选择参考资料
- 最终检查

详细规则按需读取：

- [术语与排版](references/terminology-and-typography.md)
- [API 状态与错误文案](references/api-status-copy.md)
- [受控中文技术写作](references/controlled-technical-chinese.md)
- [项目覆盖模板](references/project-overrides-example.md)

## 受控中文技术写作

操作手册、故障排查、安全说明和运维文档可以使用受 ASD-STE100 启发的受控中文写作方法，重点控制：

- 术语是否一致
- 条件是否位于动作之前
- 一个步骤是否包含清晰的主要动作
- 执行者、对象和结果是否明确
- 指代、否定范围和确定程度是否有歧义

该模块不是 ASD-STE100 的中文版本，也不表示输出符合 ASD-STE100。英语受控词典、词性和句长规则不能直接移植到中文。

## 项目覆盖

通用 Skill 不包含任何项目默认生效的业务术语。目标项目如有版本、品牌、术语或信息架构约定，应在目标项目中建立覆盖文件。

[项目覆盖模板](references/project-overrides-example.md) 只提供结构，不包含默认业务规则。

## 自动检查

仓库内置轻量检查器，将结果分为：

- `error`：高度确定的错误，默认导致检查失败
- `warning`：依赖语境的可疑表达，需要人工判断
- `style`：项目风格或术语偏好

自动检查不能证明语义正确，也不能代替作者判断。事实保真、条件顺序、指代关系和过度简化仍需人工复核。

<!-- 作者：Fenng（GitHub：@Fenng） -->