`
snoopy7713
  • 浏览: 1147098 次
  • 性别: Icon_minigender_2
  • 来自: 火星郊区
博客专栏
Group-logo
OSGi
浏览量:0
社区版块
存档分类
最新评论

软件开发过程文档如何写作?——“文档==鸡肋”?

阅读更多

“鸡肋——食之无味,弃之可惜”,软件开发过程文档遭遇了鸡肋一样的境遇。

目前敏捷软件开发过程非常流行。相对于软件开发过程文档,敏捷软件开发过程更加重视可运行的程序。
关 于软件开发过程文档,两个极端都是不可取的:一是严格要求过程文档,把过程文档作为开发过程的一个必然输出,而不考虑文档是否真正的起作用,即“过度文 档”。二是完全放弃文档,不进行任何的记录。“过度文档”偏离软件开发的实质,会造成人力的极大浪费;放弃文档则会丢失开发中的关键信息,不利于产品后期 的维护。
我们需要在上面两者之间做一个权衡。这里可以引用“二八定律”:用20%的文档,记录80%的内容。这样用最小的投入,获取最大的价值。
20%的文档要记录那些东西?
1、产品需求描述。
毋容置疑,这是最重要的一个信息。关于产品需求描述,可以写两个文档,一个是需求的整体描述;一个是功能特征表文档。功能特征表对整体需求进行分解,便于后期跟踪需求。

2、软件架构描述,软件实体作用及相互联系。
系统整体结构描述,包括系统包括多少实体,每个实体的作用,实体间的交互机制等。一般要配备图形说明。

3、程序内部结构,逻辑模块,交互。
软件实体内部逻辑模块的划分,各个模块的作用,以及各个模块间的交互机制。

4、数据库设计。
数据库,表达,字段的设计。

5、通信协议。
软件实体间交互消息描述,比如,SIP,XML等。

6、关键数据结构函数。
能够反映软件实体逻辑结构的关键数据结构定义,函数。

7、复杂问题解决方案。
对于复杂需求的解决,需要多个软件实体,或者多个逻辑模块交互实现。这些方案非常值得记录,可以方便后续产品的维护。

文档写作时间可以灵活一些,可以在项目开发过程中进行,如果开发进度非常紧张,也可以开发完成后在补充文档。如果维护过程中,对产品进行了大的更改,要及时的刷新文档,保持文档与程序的同步。

写文档过程中,文档的内容要放在首位,不可以在美工,格式上浪费过多的时间。

分享到:
评论

相关推荐

    小程序?——奢侈品牌的鸡肋之选?.pdf

    小程序?——奢侈品牌的鸡肋之选?.pdf

    实现一个鸡肋的功能————写汉字

    在IT行业中,有时候我们可能需要实现一些特殊或者有趣的功能,比如标题中提到的"实现一个鸡肋的功能——写汉字"。这个功能旨在模仿一个叫做"写汉字"的小程序,主要涉及的技术栈是JavaScript,特别是Hanzi Writer库...

    Prompt IDE来了⋯是划时代AI神器还是鸡肋?.rar

    IDE是程序员用于编写、调试和运行代码的软件工具,而Prompt IDE可能是专为AI开发设计的新一代平台。在这个讨论中,我们将深入探讨Prompt IDE可能具备的特点、它在AI开发中的作用以及它是否真正具有划时代的意义。 ...

    薄煤无人开采让“鸡肋”变“真金”——峰峰集团薛村矿实现无人值守远程自动化开采侧记.pdf

    薄煤无人开采让“鸡肋”变“真金”——峰峰集团薛村矿实现无人值守远程自动化开采侧记.pdf

    薄煤无人开采让“鸡肋”变“真金”——峰峰集团薛村矿实现无人值守远程自动化开采侧记.rar

    标题中的“薄煤无人开采让“鸡肋”变“真金”——峰峰集团薛村矿实现无人值守远程自动化开采侧记”揭示了一个关键的IT技术应用领域:矿业的自动化与智能化。在煤炭行业中,薄煤层开采由于其难度大、效率低、安全性差...

    哪些跑步装备是比较鸡肋?.pdf

    以下是一些被认定为相对鸡肋的跑步装备及其详细解释: 1. 跑步机:虽然跑步机提供了室内跑步的便利,尤其对于极端天气或无法户外运动的情况,但它模拟的路面感觉并不自然,与实际路面的反馈差距较大,可能导致跑步...

    为什么说多线程是鸡肋?神级程序员带你真正熟练使用多线程!.pdf

    【标题】:“为什么说多线程是鸡肋?神级程序员带你真正熟练使用多线程!” 【描述】:本文将探讨 Python 中多线程的局限性和如何有效地利用多线程,以及介绍多进程作为替代方案。 【标签】:Python,多线程,GIL...

    为什么说多线程是鸡肋?神级程序员带你真正熟练使用多线程!.docx

    【标题】:为什么说多线程是鸡肋?神级程序员带你真正熟练使用多线程! 【描述】:本文将探讨Python多线程为何被称为鸡肋,并指导如何有效利用多线程。 【标签】:Python,多线程,多进程,GIL,线程安全 【正文...

    Prompt IDE来了⋯是划时代AI神器还是鸡肋?.pdf

    通过这样的设计,Prompt IDE旨在简化Prompt工程的过程,提高开发效率,并帮助用户更好地利用大型语言模型解决特定信息检索任务。这种工具的出现,既反映了人工智能技术的持续创新,也为NLP领域带来了新的可能性。...

    在线式工作安排和协作管理软件——蓝点工作流管理系统

    蓝点工作流管理系统是一个B/S结构的团队工作任务管理软件,可视为一个精简的OA系统,专为解决以下问题而设计:  ——作为一名管理人员,你可能每天都有许多工作要安排给自己或下属,但常常会忘了自己给谁安排了...

    JDK1.4.2非中文API文档(真正带索引的CHM帮助文档)

    下载过本站其他几个2.09MB的1.4.2的帮助文档,很鸡肋,因为挂着CHM的噱头却是网页产品,毫无索引可言,阅读起来还不如直接放网页更舒服。这个版本绝对靠谱,带索引,跟JDK1.6的最经典版本的CHM格式的API帮助文档一样...

    (2021-2022)年专题资料免费阅读:汽车有哪些配置是鸡肋?.doc

    以下是一些被网友评为“鸡肋”的汽车配置及其不实用的理由: 1. **定速巡航**:定速巡航系统原本设计用于高速公路长途驾驶,能自动维持车辆的恒定速度,减少驾驶者的疲劳。但在城市复杂路况下,频繁的车流变动使得...

    先睹为快——iOS 10有哪些新特点?

    新的3D Touch功能将推动界面设计和应用开发的革新,统一清理功能将解决用户长期诟病的问题,预装应用的可删除性将使得设备管理更为灵活。而Apple ID多账号登录和屏幕色温调节则预示着iOS 10将加强个性化和用户健康...

    GUI 的 JavaWeb 鸡肋代码生成器 确定不了解了解?.pdf

    Mybatis-plus 代码生成器是其一部分,可以自动生成实体类、Mapper 接口及实现、Service 及 Dao 层代码,大大简化了开发过程。同时,通过集成 GUI(图形用户界面),使得生成代码的过程更加直观和便捷。 为了使用这...

    智能空气净化器不“智能”,反成鸡肋?

    "智能空气净化器不智能,反成鸡肋?" 在当下的智能时代,智能空气净化器似乎已经成为了家电行业的一个热点话题。然而,在智能空气净化器的razy追逐中,究竟什么是真正的智能?智能空气净化器真的智能了吗?或者只是...

    IE开发者工具 F12调试工具 详细使用说明文档

    同时 他也提供了一些虽然比较鸡肋 但是还能咂咂味的小工具 例如取色 屏幕尺子等 ">IE开发人员工具 F12调试工具 就是为前端开发人员开发页面而设计的工具 提供一系列的小工具 让你可以方便的查找 调试页面的BUG 包括...

    FPGA研发之道(21)-鸡肋?

    《FPGA研发之道——SOPC的探讨》 在FPGA设计领域,SOPC(System On a Programmable Chip)常常被比作“鸡肋”,认为它“弃之可惜,食之无味”。这种观点源自于SOPC在性能上的局限性。SOPC中的软核处理器通常运行在...

    非程序员2001-22

    - **解决实际问题**:课程针对开发过程中常见的具体问题进行了讲解,如用例的正确识别、用例文档的编写方法、分析类的设计原则等,以期帮助学员避免常见误区,提高开发效率。 ### 4. 统一建模语言(UML)的发展历程 ...

    AI芯片是鸡肋还是真有用.pdf

    随着软件应用的不断进化,AI算法将被越来越多地集成到实际应用中,AI芯片将成为必需品。在算力和能效方面,AI芯片将持续推动手机等设备性能的提升。未来,随着AI技术的不断进步,我们可以预见AI芯片将在图像修复、...

Global site tag (gtag.js) - Google Analytics