本文题目:我写了我的第一个软件设计文档来赢得新项目。
写一份好的软件设计文档可以让您的项目申请在众多竞争者中脱颖而出。然而这往往是一项被低估了的工作。有人觉得这并不是码农工作的核心,只是个“次要”的环节。我们不妨看看 Jared I. Daszak博士正在工作的软件开发公司他的故事。
他在开展新项目之前并不知道需要设计文档。但当新项目开始后,他的上司要求他为该项目编写一份软件设计文档。他随后问了几个同事怎样应对这个课题,他得到的建议都说:“请查找在线的模板,然后从头开始构建它。”他决定在他的休闲时间里去研究和尝试编写一份软件设计文档。
他研究了大约一周的时间之后,他写作了一份可以说是非常完整的文档。该文档包含了如下元素:给予简介,技术架构,数据设计,使用用例说明等等。一份好的软件设计文档必须具备简明扼要的内容,易于阅读,同时又具备条理性。
事实上,任何一份好的软件设计文档都应该起到沟通和协作的作用,不仅仅只是一份文档。这份文档中包含的信息,应该尽可能地详尽,以便其他人可以理解和遵循代码和业务逻辑等方面更好的发挥。这些信息将使得他人快速评估和协助完成任务,它们帮助促进团队合作,并激励关注细节的动机。
简而言之, Jared I. Daszak博士发现,他的软件设计文档成为后续沟通和指导的中心。也正因此,他成功博得了新项目。软件开发公司也获得了一个用于招募新人、强化软件开发团队并推广新项目的强有力的工具。
对于所有从事软件开发的人,写作软件设计文档可以帮助整个项目获得更好的结果。只有投入了足够的时间和精力去撰写一份好的软件设计文档,团队才能更长远地成功。
了解更多有趣的事情:https://blog.ds3783.com/