Technical Document Writing Guidelines

Technical Document Writing Guidelines

💡 原文中文,约1000字,阅读约需3分钟。
📝

内容提要

本文介绍了技术文档写作规范,包括文章结构、排版规范和写作风格等方面。文章结构应包括标题、效果、原理、总结和参考与致谢等部分。排版规范包括段落、空格、文本样式等方面。写作风格应尽量避免使用长句,论点要有论据支持。同时,本文提供了个人文案排版规范,并受CC BY-NC-SA 4.0协议保护。

🎯

关键要点

  • 技术文档写作规范包括文章结构、排版规范和写作风格。
  • 文章结构应包括标题、效果、原理、总结和参考与致谢等部分。
  • 排版规范要求段落之间有空行,首行无需缩进。
  • 中文与英文、数字之间需添加空格,避免错误排版。
  • 文本样式中,中英文混排时使用中文全角标点,整句英文使用英文半角标点。
  • 写作风格应避免使用长句,论点需有论据支持。
  • 个人文案排版规范受CC BY-NC-SA 4.0协议保护。
➡️

继续阅读