中文技术文档写作风格指南#

参考：zh-style-guide

• 说明
• 语言风格
  • 对话式语言
    • 案例
      • 案例一：GitHub官方文档优化
      • 案例二：Google开发者文档示例
      • 案例三：某云服务API文档优化
      • 案例四：DeepWiki对话式文档应用
      • 案例五：技术方案文档结构优化
  • 客观礼貌
    • 语气规范
    • 语气规范
    • 句式规范
  • 简洁清晰
    • 具体要求
    • 禁止项
  • 通俗易懂
    • 基本原则
    • 典型案例
      • 技术领域缩略语
      • 运维领域行话
  • 用词恰当
    • 1. 结构规范
    • 2. 禁用词规范
      • 2.1 通用禁用
      • 2.2 技术场景扩展
    • 3. 常用词规范
  • 用户导向