diff options
Diffstat (limited to 'parnas-a-rational-design-process.rst')
| -rw-r--r-- | parnas-a-rational-design-process.rst | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/parnas-a-rational-design-process.rst b/parnas-a-rational-design-process.rst index 79070e8..523a924 100644 --- a/parnas-a-rational-design-process.rst +++ b/parnas-a-rational-design-process.rst @@ -531,9 +531,17 @@ Page 17 (周佳威 翻) -这样生成的文档读起来不容易、不轻松，但也不枯燥。 我们用表格、公式和正式符号来增加信息密度。 我们文档结构规则避免了信息重复。 这样的文档必须聚精会神地读， 但是会回馈给读者以详细准确的信息。 - -为避免传统文档遍布着混淆的与不一致的术语的情况， 我们用一种由特殊括号与类型字典组成的术语系统。 每个必须定义的术语都被嵌在一对括号符号中， 括号符号反应了术语的类型。 对每个类型，我们有一个字典， 字典包含了对该类型的定义。 虽然刚开始阅读我们文档的读者会觉得 !+terms+!、 %terms%、 #terms# 这些符号干扰了阅读， 但是经常读我们文档的用户会觉得这些特殊括号隐含的类型信息反而会使阅读变容易。 类型字典减少了我们为同一个概念定义两个术语， 或者为同一个术语给出两个定义的可能。 特殊括号对已经引入但但未定义， 或已定义但从未使用过的术语进行机械检查变得容易。 +由此生成的文档读起来不容易不轻松，但是不枯燥。 +我们用表格、公式和正式符号来增加信息密度。 +我们的结构规则避免了信息重复。 +结果是这样的文档，它必须被专心地阅读， 但是会给读者详细准确的信息。 + +为了避免传统文档遍布着令人困惑的与前后矛盾的术语的情况， 我们采用一种特殊括号与类型字典系统。 +每个必须定义的术语都被嵌在一对反应术语类型的括号符号中。 +对每个这样的类型，我们都有一个仅包含对该类型定义的字典。 +虽然一开始读者会觉得!+terms+!、 %terms%、 #terms#的存在烦人， 但是我们文档的老用户会发现这些括号暗含的类型信息使得文档更容易阅读。 +类型字典的使用减少了我们为同一个概念定义两个术语， 或者为同一个术语给出两个含义的可能。 +特殊括号符号对已经引入但未被定义， 或已定义但从未被使用的术语实行机械检查变得容易。 .. 上面描述了我们希望遵循的理想流程以及在此流程中生成的文档。我们通过生成 文档来伪造这个过程，如果我们以理想的方式做事，就会生成这些文档。我们试 |