风格指南
这份文件用于约束仓库文档和示例的写法,让中文化后的内容保持一致。
文件命名
- 保留原目录名和文件名
- 不把运行相关文件改成中文文件名
- 顶层文档继续使用现有命名规范
文档结构
- 一个文件一个核心主题
- 优先先讲“是什么”和“什么时候用”
- 命令与示例尽量靠近说明
文字风格
- 术语优先保留英文
- 中文解释尽量直白
- 少写翻译腔长句
- 面向中文初学者
代码与配置
- frontmatter key、JSON/YAML key、命令、flags、环境变量一律不翻
- 代码块优先保持可复制执行
交叉引用
- 优先链接到本仓库现有文件
- 避免写失效路径