的问题和规则来进行评论,因为主题、风格和技术彼此之间有很大差异。然而,有一些指导方针可以确保质量改进。主要的质量标准是:文档的编译和格式是否能够为目标受众所理解?他实现了他的目标吗?在有限的背景下,它是否正确且准确?评论的一般准则是:
让你的笔记简短、准确、具体。如果开发人员明白为了简洁而省略了明确的问题,这将使沟通变得更容易并减少混乱。
圆圈中的符号 n(读者注释)标识注释。要编写 n 个注释,请从“读者注释”列表中确定该注释的序列号,为该注释分配一个编号,圈出它,然后用适当的波形符连接该注释。 (参见 C.4 标准图表表格。)
批评应该是建设性的。尝试提供解决方案或明确指出问题的根源。
花时间阅读并总结所有评论。它们可以放在封面上或单独的纸上。 (不要包含任何已发布在其他页面上的内容。)开发者/评论者会议上讨论的问题可能会被概括。讨论的问题清单必须具体。
批评所花费的时间长短取决于许多因素:对所描述内容的熟悉程度、该主题之前被讨论过的次数、读者和开发人员的经验等。工具包返回给开发人员,除了读者的签名之外,没有任何评论打勾表示读者完全同意开发者的观点。读者应该意识到他和开发人员对文档的质量负有共同的责任。
C.2.2.2 开发者-评论者互动
当读者返回 Kit 时,开发人员会在每个 n-note 上放 圣多美和普林西比消费者电子邮件列表 置“A”或“X”来回应(“A”表示开发人员同意评论者的观点,并将将该评论合并到下一个版本中)。套件的。 “X”表示开发者不同意。开发者必须以书面形式注明不同意的原因,以及评论的位置。开发者回复所有评论后,套件将退还给读者妥善保管。
C.2.2.3 会议指南
在以书面形式提供评论和回复之前,不鼓励读者和贡献者参与对话。
待举行的会议安排如下:
每次会议都应有时间限制。
每次会议都应首先讨论与一个或多个开发人员评论和响应相关的具体问题,并且会议应寻求解决这些问题。
每次会议应该在参与者一致认为生产力水平下降并且个人努力会更有益时结束。
每次会议应以商定的议程项目清单结束,其中可能包括具有具体议程的后续会议的时间表。
每次会议都必须指定一名“秘书”,负责记录提案、决定和主题。
6. 严重的未解决问题应通过记录争议双方的方式进行专业解决。
会议结果应为问题的书面决议或由相关管理机构解决的问题清单。任何参与者都可以通过额外研究的形式提出解决方案。
C.3 IDEF 试剂盒
该套件是一份技术文件。它可能包含图表、文本、术语表、决策摘要、背景信息或提交供审查和评论的任何内容。相应的扉页以套装的形式呈现材料。封面页包含开发人员、日期、项目、文档编号、标题、状态和注释字段。
IDEF 套件有两种类型:
该标准集旨在用于评论目的。它被认为是一个“工作文档”,旨在帮助设计师完善他的整体模型。
升级套件包含该型号的最新版本。发送它只是为了提供信息,旨在帮助维护有关整个模型的当前信息,同时在套件循环中处理部分模型。更新包只能包含自上次更新以来已更改的页面。
标准套件包含模型的各个部分,并且通常随着工作的进展而呈现。标准试剂盒根据 IDEF 试剂盒周期提交供审查,并且属于本附件其余部分提到的类型。更新套件会定期提供。这些套件包括最新版本的模型。升级套件的接收者不应发表评论,尽管他们可以自行决定发表评论。更新工具包由接收者存储在存档中。