在我的编程方法(WG2.3)的IFIP工作组的第一次会议上三分钟,Edsger Dijkstra举手 - 或不说:“为什么这个箭头红色和那个蓝色?“会议的主席(Natarajan Shankar)通过说,”你不必回答这个问题“并敦促我继续下去。Dijkstra令人惊奇地敌对花哨的演讲技巧和任何类型的吹风。我不确定他与PowerPoint和解自己。但他有一个观点。经常,技术文本通常用图片替代物质。
图形插图可能是理解的很大帮助。它们特别适合于给出问题和解决方案的结构。但是,它们的使用需要谨慎。(这些观察是关于我即将到来的要求工程和业务分析的摘要大部分摘要1,也为我的背景提供了背景上一篇关于这个博客的文章。)
看到读者在读者处闪光花式图形而不小心定义正在使用的约定的精确含义,这一切都太常见了。这种“框和箭头”图在网络中特别常见,如下图来自维基百科,描述了“面向服务的架构”的组件和连接。
此示例根据许多图形插图中的问题键入问题:
这种图片,因为它们在精确度弱的令人瞩时强烈,在技术文件中是常见的。他们是珍贵的,因为它们使读者能够快速掌握系统的结构。然而,这种印象可以是欺骗性的。
当使用此类插图时,我们应该特别注意图表元素之间的连接器 - 通常,某种线条或箭头。
通常情况下,图为作者包括箭头以指示组件A以某种方式依赖于组件B,或者以某种方式(或者知道B,或者使用B,或者使用B,或者在某些未指定的B中涉及b大大地。这种模糊性在任何用于对系统开发产生影响的技术文件中是不合适的。“注意轴承箭头的盒子。”
除非他们明确地说明所有图形符号的含义(语义),否则图片可以做得更好。
除了连接组件的箭头之外,表示组件本身的符号需要具有精确指定的语义。如果您有各种各样的使用正方形,矩形,椭圆形,圆圈和其他形状,请确保它们对应于您的突发发生物,而是对不同的概念,每个都明确说明。
我们现在永远不会满足于此类纪律之后的插图是否满足Dijkstra,但至少他们在帮助而不是令人困惑的读者时有一个很好的镜头。
[1] Bertrand Meyer:要求和业务分析手册,2021,出现。
Bertrand Meyer.是Schaffhausen Tearphoto(瑞士)的教授和普通教授,是Innopolis大学的访问教授,以及埃菲尔软件(Goleta,CA)的首席技术官。
没有发现任何条目