我要告诉你一个秘密……开发人员讨厌编写文档。好吧,也许这不是什么秘密。我们勉强接受将文档作为我们核心交付物的一部分。虽然我们可能会抱怨文档妨碍了“实际工作”,但我们确实理解文档的基本需求(尤其是当我们正在寻找系统新部分的更多信息时)。解决问题的适当时间估计应该包括足够的时间来编写文档,以促进应用程序的长期健康和可持续性。
开发人员文档中经常被忽视的一个领域是图表。这种忽视有很多原因。有用的图表比几句话需要更多的时间来创建。图表可能更多地被视为项目管理或业务分析师的功能。即使是像对用于创建、修改和共享图表的最佳工 印度手机号 具缺乏共识这样简单的事情,也可能阻止开发人员创建它们。
那么开发人员为什么应该关心图表并将其视为他们负责的活文档呢?
团队扩张、收缩和重组
每位开发人员在其职业生涯中都曾多次成为团队的新成员。作为新手,最初的几天通常都是忙忙碌碌,要获得适当的网络和工具访问权限、设置工作开发环境,并阅读(可能)大量的应用程序文档。虽然大部分精力通常都花在书面文档上,但如果有好的视觉文档,那不是很好吗?
从经验上讲,答案是肯定的!无论是系统架构、包布局、 ER 图还是系统中无数其他潜在的图表点,拥有可用的视觉记录源都可以帮助新团队成员快速上手。
使用 Lucidchart 招募您的软件工程师
了解方法
在现代敏捷开发环境中,让开发人员更快地掌握知识并提高工作效率是项目成功的关键。我们不再像在旧的瀑布模型下那样,让新团队成员在几个月内轻松进入团队。在这些环境中,不断发展的图表是必需的。
在流程的另一端,开发人员将离开项目。无论是由于转入另一个团队、在应用程序投入生产时重组团队,还是探索其他机会,团队组成都会发生变化。良好的文档将确保系统知识不会丢失。
对图表的专注将在这里大放异彩。在许多情况下,通过视觉媒体传达状态比依靠书面文档更容易。这一点尤其重要,因为团队成员离开后可能没有人可以回答问题。留下来的人会感谢你为维护动态图表所做的努力。
缓解 PM 和利益相关者的请求
接下来的部分属于管理经理的范畴。在大多数开发人员眼中,管理的范围就是开会……很多很多的会议。而演示幻灯片是会议的核心。
遗憾的是,我们无法免受应用程序管理的这一部分的影响。除了被拉进会议,妨碍开发人员认为的“实际工作”之外,我们还经常被要求为会议制作幻灯片(或至少是幻灯片中包含的材料)。你的开发经验和架构见解越出名,要求你提供意见的请求就越多。
维护良好的图表将减轻您的负担。您将能够引导 PM 和其他利益相关者查看图表,而不必在最后一刻整理一些东西(因为许多此类请求都是如此)。根据图表中的细节,您可能可以完全避免参加许多会议。有了可用的高级图表工具,您的图表通常可以讲述一个完整的故事,而您几乎不需要进一步输入。
对于开发人员来说,图表的第二个考虑因素是其说服作用。有了好的图表来支持您的论点,说服管理层接受某些方向和决策(例如迁移到 AWS、包含 Redis 集群或请求的功能的可行性)就变得容易得多。对于可以并排显示历史进展、预测结果和建议架构的详细图表来说,尤其如此。使用动态图表作为决策依据的一部分将帮助您更快地与管理层达成共识。
综上所述
这些只是制作和维护良好图表对开发人员来说很重要的几个原因。您可能已经注意到,在谈论图表时,我没有使用“视觉辅助”一词。虽然这个术语在提到图表时经常使用,但它设置了一个不好的上下文。这个术语通常让人联想到一些无法独立存在的东西,一个对整体来说不必要的可切除部分。您永远不应该这样看待您的开发人员图表。图表是您的核心文档的重要组成部分。它们应该足够强大,能够独立存在,讲述完整而引人入胜的故事。
为什么开发人员应该使用图表作为核心文档
-
- Posts: 5
- Joined: Sun Dec 22, 2024 5:19 am