diff options
author | Hui Lan <lanhui@zjnu.edu.cn> | 2021-05-08 22:17:34 +0800 |
---|---|---|
committer | Hui Lan <lanhui@zjnu.edu.cn> | 2021-05-08 22:17:34 +0800 |
commit | d0f0849816fd1b6911db16362854155c2fc78975 (patch) | |
tree | 61526bb5f1f9eaa39f7a07e7c71b884d254edd07 | |
parent | 18a13601bdd135419155c68756e5b32598050994 (diff) |
parnas-a-rational-design-process.rst: 融入陈依贝的翻译 (PDF page 15).
-rw-r--r-- | parnas-a-rational-design-process.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/parnas-a-rational-design-process.rst b/parnas-a-rational-design-process.rst index 066dad7..eb8a7c1 100644 --- a/parnas-a-rational-design-process.rst +++ b/parnas-a-rational-design-process.rst @@ -492,7 +492,30 @@ VI. 文件在此过程中充当什么样的角色? 软件发生变化时,找不到所有文档对应的位置去修改。 +Page 15 +---------------------------------------------------------------------------- + +这两种文档风格的问题都在于,除了作者之外,其他人找不到他们想要的信息。 +因此,确定事实缺失或纠正事实错误并非易事。当软件更改时,要找到文档中应该更改的所有部分并非易事。 +这些文档维护起来会非常昂贵,而且在大多数情况下将得不到维护。 + +— 枯燥的行文。 +我们发现很多要说的话可以用一条编程语言语句、一个公式或一个图表来说。 +我们发现某些事实在许多不同部分被重述。 +这增加了文档及维护它的成本,并导致无法集中注意力阅读以及无法发现错误。 +— 令人困惑和不一致的术语。任何复杂的系统都需要发明和定义新的术语。 +如果没有它,文档将会太长。 +然而,软件文档的编写者经常不能为他们使用的术语提供准确的定义。 +因此,这些术语不能被一致使用。 +仔细阅读可以发现,许多术语被用于同一概念,许多相似但有区别的概念被同一术语描述。 + +—不完整性。在项目接近完成时编写的文档是由长期使用该系统的人编写的,以至于他们认为重要决策是理所当然的。 +他们记录他们认为会忘记的小细节。 +不幸的是,结果是一份对熟悉系统的人有用的,但对新手却是无法理解的文档。 +在大型软件项目中,总会有新手。 + + Page 16 ------------------------------------------------------------------------------ |