技术文档撰写的要素

作者: 孟话英语 | 来源:发表于2019-08-11 18:45 被阅读4次

盖瑞·布莱克(Gary Blake)和罗伯特·布莱(Robert W Bly)在他们合作的《技术文件撰写的要素》(The elements of technical writing)中,提出了7条撰写规则。

孟话英语认为,这7条规则,还原了写作的本质,其实也适用于普通写作。

• Use the active voice

使用主动语态

• Use plan rather than elegant or complex language

使用浅显易懂的词语,而非高雅或复杂的词语

• Delete words, sentences and phrases that do not add to your meaning

删除没有实质意义的单词、句子和短语

• Use specific and concrete terms rather than vague generalities

使用明确具体的词句,而非含糊空泛的概括

• Use terms your reader can picture

使用读者能够在头脑中描绘的词语

• Use the past tense to describe your experimental work and results

使用过去时描述实验和结果

• In most other writing, use the present tense

除此以外多数情况即使用现在时

相关文章

  • 技术文档撰写的要素

    盖瑞·布莱克(Gary Blake)和罗伯特·布莱(Robert W Bly)在他们合作的《技术文件撰写的要素》(...

  • 在VS Code中编辑Markdown文档

    上节《用Markdown撰写IT技术文档、博客和电子书》讲述了为什么要用Markdown撰写技术文档,以及使...

  • 如何撰写技术文档

    本文最后更新于2022年04月30日,阅读时请注意时效。 围绕“高效精准解决问题”简单介绍一下撰写技术文档的一些注...

  • 2021-01-23 浅谈技术文档的撰写

    从事互联网行业或者技术行业的人来说,撰写技术文档这项工作肯定不陌生。但如何撰写技术文档呢?我从我的角度来总结一下,...

  • 如何使用Markdown撰写技术文档

    本文不涉及具体的 Markdown 语法教学 本文主要介绍在使用 Markdown 语法来进行技术文档写作时,如何...

  • 技术文档的快速写作模板

    1. 问题描述 技术写作是为了总结解决问题的实用技术,而撰写的文档,对团队的技术积累非常关键。 为了准确、高效的传...

  • 需求文档撰写

  • 文档撰写规范

    一、命名规范 1. 文件命名规范 项目命名词(或项目编号)_文件命名词_日期_V版本号.文件后缀 项目_文件描述_...

  • 如何撰写文档

    今日听了魏老师的如何撰写产品文档的课程,收益良多。 先说下撰写文档的前提: 1、明白是给rd/qa写的,明确他们关...

  • 产品需求文档撰写指南

    一份详细的产品需求文档撰写指南,结合实例,分析细致。 在产品经理的日常工作中,经常需要借助各类文档来和技术、设计等...

网友评论

    本文标题:技术文档撰写的要素

    本文链接:https://www.haomeiwen.com/subject/novtjctx.html