问题 单项选择题

程序员需要用文档来表述自己的思想。文档设计的要点不包括()。

A.文档制作应先做规划,列出纲目。内容的逻辑性要强,并不断改进

B.选择最适合表达某种算法的形式(文本、表格、图)

C.尽量保持文档与程序的一致性,文档上下文的一致性

D.采用文档模板以减少以后随软件版本的升级而更新文档的工作量

答案

参考答案:D

解析:

本题考查软件工程中有关文档设计的基础知识。

程序员需要用文档来表述自己的思想,文档设计的要点包括:

(1)编写文档前应先做规划。可以参照有关标准以及成熟产品的案例,先列出文档的纲目。文档内容的逻辑性要强,要让人易于理解。要编写进度计划。编写文档常常不是一次完成的,需要先写出初稿,并经过自己多次修改,再送有关人员修改,待基本定稿后,再送审。

(2)要选择最适合表达某种算法的形式。有些内容适合用文本表示,有些则采用表格更好,有时用图来表示更清晰。

(3)软件产品包括程序和文档。程序与文档要保持一致性,文档上下文也要保持一致性,不能出现矛盾。有时随着程序的不断修改,很难完全同步修改文档,但要求尽量做到同步。起码在对程序修改进行了一个阶段后,就应修改相应的文档。虽然完全同步修改文档的代价有时会太高,大多数人也不会这样做,但总体来说,保持一致性十分重要。反过来,文档不一致会造成理解、使用和维护软件的困难。

(4)要保持良好的文档风格,其重要性等同于保持良好的程序设计风格。

软件工程鼓励开发者按相应的文档模板来编写文档,特别是大型软件企业本身建立了文档规范。利用文档模板,可以减少遗漏,考虑得更全面,文档的质量也更高。但是,许多软件的创新性强,没有相应的模板供参照。此外,即使使用了文档模板,在软件升级时对文档的修改也同样需要做不少工作,减少修改工作量不是采用文档模板的主要原因。

简答题
判断题