diff options
| -rw-r--r-- | parnas-a-rational-design-process.rst | 22 |
1 files changed, 16 insertions, 6 deletions
diff --git a/parnas-a-rational-design-process.rst b/parnas-a-rational-design-process.rst index 57d2983..130a13f 100644 --- a/parnas-a-rational-design-process.rst +++ b/parnas-a-rational-design-process.rst @@ -364,17 +364,27 @@ Page 15 陈俊蕾 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -这（文档多余的注解）是没必要的，且会使系统维护变得更加昂贵。除此之外，还会增加代码与原文档不符的可能性。 +文档中多余的注解是没必要的，且会使系统维护变得更加昂贵。 除此之外，还 +会增加代码与原文档不符的可能性。 -文件在此过程中充当什么样的角色？ +VI. 文件在此过程中充当什么样的角色？ +`````````````````````````````````````````````````````````````````````````````` -通常的文档到底哪儿出错了呢？为何如此难使用？为何不可读？ +现在的文档到底哪儿有问题？ 为何难用？ 为何没人读？ -这应该被清晰地认识到，在我们描述的过程中文档扮演着一个重要的角色。许多程序员事后回想起都视这种文档为一种不可避免的不幸。它们（文档）被书写只为应一些官僚的要求。我们相信那些在发布前未被使用的文件都将是错误的文件。 +显然，设计过程中文档扮演着一个重要的角色。是祸躲不过，许多程序员认为文 +档是“事后考虑”之物，只是官僚的要求而作。我们认为那些在发表前从未被使用 +的文档都是很差的文档。 -大多数文件是不完整、不精确的，但这些都不是大问题。如果是，那么可通过添加或修改信息进行简单的修正。事实上那些潜在的、组织上的问题，所引发的不完整和不正确是没那么容易修复的。现如今的文档，可根据其特点分为“意识流”和“执行流”两种。意识流的作者会在每个灵感闪过的瞬间记录所有点的内容。而执行流的作者会根据事件发生的顺序去描述系统。 +大多数文档都不完整、不精确，但这不是主要问题。可以通过添加或修改信息进 +行改正。 事实上是引起文档不完整与不正确的内在结构组织问题不容易修复。 -这两种书写文档的风格共同存在一个问题，就是：除了作者本人之外，其他人将难以找到他们所寻找的信息。这会使得判定信息是否丢失或者信息是否出错变得不那么容易；也会使得软件修改时，找到所需修改的所有文档内容变得不那么容易。 + +- 很差的文档组织结构。 现今的文档，可分为 **意识流** 与 **执行流** 。 + 意识流写作把即兴想法写在作者正在写的地方。执行流写作按照系统运行时事 + 件发生的顺序去写。 这两种文档风格的问题是：除作者本人，其他人不容易 + 找到他们想要的信息。 因此难以判定某信息是否丢失，难以修改错误信息。 + 软件发生变化时，找不到所有文档对应的位置去修改。 |