[译·如何写技术文章]总览

译者注

最近打算读google出品的教程:如何写技术文章,看起来是一套完整详尽的教程,没有原生的中文翻译,为了让自己能坚持读完,所以这里立一个小目标——翻译这篇教程。

译者注

不保证译文的正确性sticker

“如何写技术文章”的总览

  以下表格是本教程的大纲:

标题 简介 预备课时 课时
第一节 技术写作最重要的基础课程,在学习其他课程前,请先完成此课程 2小时 2~2.5小时
第二节 技术写作时需要训练的4个中级课题 1小时 2~2.5小时
易读性 发展“如何让文档更易读”的技能 1.5小时
如何打印错误信息 写出更清晰有效的错误信息,无论是在IDE,命令行或是图形界面里。本课程为在线课程 1.5小时

  预备课时用来介绍课题;课时用来帮助读者整理和练习课题。所以说,重要的知识在预备课里。

  Google提供所有课时练习所需要的素材。如果你打算帮助其他人学习本课程,请参考Facilitating Technical Writing Courses


  第一节第二节面向如下读者:

  • 软件开发者
  • 软件开发或计算机科学的学生

  此外,很多与工程相近的工作(例如项目经理),也能从本课程中学到东西。   易读性面向所有技术写作和创建技术网站的人:

  • 工程师
  • 工程经理
  • 项目经理
  • 技术创作者
标签:翻译
8个月前
0