正确易懂的文档作成的10个技法

 

文档作成能力是从事软件开发人员必备的一项技能，优秀的文档能使沟通更加顺畅。特别是在国际合作或软件外包行业中，文档的简单易懂更加重要。以下是针对在对日外包中文档作成的10个技法，希望给朋友们一些帮助。

 

 

一、用日语作文档时，避免使用片假名，中文做文档时，避免使用非专业的直译名词。

理由：容易引起歧义和难以理解。

对策：日语的片假名尽量替换成日文汉字，并且能够注上英文原词。中文文档时没有标准翻译的专业词汇尽量采用英文原词。

 

二、一篇文章表达一个主题

理由：一篇文章有几个主题，让人很难把握重点，难以理解。

对策：采用金字塔式的结构将文章逐条分解。

 

 

 

三、文章的项目编号一定要标出。

理由：如果没有编号，文章的结构比较模糊

对策：①分项，分段要多用。

       ②图和表的编号一定要标注。

       ③在沟通过程中以及其他文档引用时使用项目编号进行对话，很容易找到目标文字。

 

四、采用自动翻译进行文章的确认。

理由：如果不能自动翻译或者翻译很差，说明文章中有语句不够通顺的地方，我们自己也难以理解。

对策：使用翻译软件或者翻译网站等进行翻译，对翻译出入较大的地方进行修改。注意句式结构。

 

五、文章记述粒度（详细度）要一致。

理由：详细程度不一，导致文章或者项目组内文档的意思和理解的容易度混乱不一。

对策：①对于记述粒度要有统一的指导方针.

　　　②分情况书写时，不要使用“其他”这样的情况。

　　　③第三方进行记述粒度的检查。

 

六、词语要有严密的定义。

理由：模糊的词语会使读者难以理解，必须通过上下文的理解才能判断词语的意思。

对策:①要写出文章中各项的说明及读者阅读说明。

      ②整理出文章中的用语集。

 

七、否定句变为肯定句。

理由：这个对日文文档特别注意，因为日文的否定比较暖昧，难以理解。从心理学角度，肯定句比否定句容易让人理解和接受。

对策：采用肯定句型。

 

八、先写结论，后写说明。

理由：先写出结论，让读的人很容易把握整体的主旨。

对策：对于短小的文章最好采用先写出结论后写说明的习惯。

 

九、减少文字说明，尽量使用图和表进行说明。

理由：徒劳，重复，冗长的表达太多。

对策：①少数图形使用按照MECE原则作成的图解结构

      ②采用UML绘制的图形。

      ③对于图形中的文字，只允许使用单句。

      ④对于连续的流程，处理集群，因果关系和关联关系要特别的强调。

注：MECE---是Mutually Exclusive Collectively Exhaustive，中文意思是“相互独立，完全穷尽”。

   也就是对于一个重大的议题，能够做到不重叠、不遗漏的分类，而且能够借此有效把握问题的核心，并解决问题的方法。

 

十、表格很差，还不如逐条的去写出来。

理由：不好的表格，对于理论的结构、流程、相互的关系不能很好的表象出来。

对策：①重视对表达内容的关联关系时，要舍弃表格的美观性。

       ②优先考虑表达内容的充分性，要舍弃表格的美观性。

       ③如果使用表格要遵循以下原则： 

           ※      每个条目简短表达

           ※      每个条目要遵循MECE原则

           ※    保证每个条目内容表达充分