国内的IT企业的API文档跟Android官方文档比较起来,简直可以说是地上爬的跟天上飞的。
质量、严谨程度、美观程度相差甚远;
可以看得出Google的工程师工作非常细致负责,国人在方面相当相欠缺。
Google文档句式整齐统一、颜色和字体搭配合理、美观、内容充实,文章组织有条理。而中国IT企业的文档大都是技术弱的同事(甚至非技术人员),利用wiki,用工具生成的。不经整理。给人一种很凌乱的感觉。概述部分说法抽象、模糊,不愿意多写,写文档积极性不高,不能概括出他们系统的功能。而且很少随软件一起更新。很多地方吹嘘的口气多于实用信息。
Android 文档
1、阅读顺序没有强制要求
2、几乎都是每个段落集中讲一个东西,非常有规律。
3、重要信息的字体比较大,或者是链接。对于快速回顾很有帮助。
4、API文档重点是记住名字、类型。
但是为什么英文难理解,分析思维方面的问题,得出原因:
1、英文过于追求表达准确,强调语法:第一、三人称。。。 单数复数。。。时态。。。用这些语法结构精准地描述事物。
2、主次顺序与中文相反,重要的信息常常位于句子后半部。。。重要信息作为定语从句,前半句显得毫无意义没多少信息。
3、有时动词名词不分,动词直接作为名词,表示抽象概念。
4、习语、短语多,从字面上无法直接理解涵义,这些短语的真正含义与单词本身含义相差甚远。
5、而且阅读英文文档的时候,要按句子结构理解,注意节奏和断句。