如何写开发文档 如何写开发文档的方法

大家好，今日源源来为大家解答以上的问题。如何写开发文档，如何写开发文档的方法很多人还不知道，现在让我们一起来看看吧！

1、一个系统设计完成以后，它不应该仅仅是一些源代码，还应该包括各种各样的开发文档这对以后自己对系统的维护和升级都有很好的参考作用一个系统开发完成，它究竟应该包含那些文档，这些文档一般是怎么完成的，应该包含哪些内容？这就是系统开发的规范化问题系统开发的规范化不利于自己，也有利于公司，更有利于新手规范化的设计让工程师工作更高效，这已经是不用争论的事实现在在大型软件工程开发方面，这已经做得相当好但在单片机和嵌入式系统的开发方面，规范化的工作却有待我们共同探讨在国内，一些公司的研发人员也有一种误导——快写代码，快让我看见功能，不要你做其他的，完成功能就好这些都把我们的设计导入一种误区：大部分时间都在写代码，改代码嵌入式实时系统复杂度的提高，设计工程师在定义和分析系统初始要求时必须认真考虑软硬件的协同关系通常设计工程师还必须权衡系统的灵活性、速度、成本、和可用工具之间的关系本文打算描述嵌入式系统和实时系统的关键特性，并探讨在选择或开发硬件和软件组件的基础上开发高效嵌入式系统的解决方案，同时详细说明嵌入式系统和实时系统开发所特有的关键工艺技术我所知的realtime-uml的设计软件:TNI公司的Embedded,Rational:RoseRTiLogix::Artisan:TauTNI公司的Embedded全流程解决方案，涵盖了整个嵌入式控制软件设计的全部过程：从用户需求、规格说明、设计、代码生成、仿真校验直到验收在设计的最初阶段使用可执行的（形式化的）、可视化的规格说明书和用户进行沟通，消除设计人员和用户之间的歧义利用仿真对设计进行校验测试，并在整个设计过程中进行递进式的校验，在设备安装之前发现可能存在的大量设计错误和问题，大大缩短现场调试的时间支持功能性设计，图形化IEC61131-3语言，符合EN50128安全标准重复使用设计自动生成设计文档容易使用，快速建模为各种软、硬件平台自动生成C代ROSE进行分析设计RoseRT是Rational在收购objecttime以后的推出的，该工具主要是基于一个叫做ROOM的模式，所有可执行其好坏我也感受不抬出来（ilogix的道先生对ROOM不太赞同）RoseRT的界面感觉比较复杂，代码生成也可以，但效率无法评价仅提供了系统的动态和静态模型文档Rhapsody目前国外好多大公司都是用Rhapsody进行嵌入系统的建模，进行软件设计的Rhapsody是一个模型驱动的开发环境，它以UML20为基础，使大小不同的项目都能够通过可视化建模的方法分析、设计、实现和测试自己的工作，构建和配置实时嵌入式应用Rhapsody专为嵌入式市场的特殊需求设计和优化，包括实时系统的行为语义，实时作系统的支持，无作系统的实时应用支持，遗产代码的逆向工程、设计级的调试、高效的代码自动生成（C、C、Ada、Ja）和文档自动生成等很不错的工具，可以把UML图直接转换成C或C代码但它也会在系统中引入它的一个程序框架，用以支持顺序图、状态图的运行、调式和仿真它带来的好处显而易见，但同时，它对很多嵌入式应用又形成阻力例如，如果你新增功能是在原来的已有的过程式软件包上打个补丁，新的框架和原系统的怎么配合？那么你得真正消化和吸收这个附加的框架，这个难度应该不底于探索MFC结构对于一个完全新的项目，Rhapsody很不错对于扩功能打补丁的项目，三思呀不知道RoseReal-Time在这方面的表显如何？Rhapsody有很多diagrams,设计人员直接通过画图,codegeneration就生成优质代码,很有意思Rhapsody真正把开发人员与设计人员区别开来,这就要求设计人员完全按照软件工程思想来实施,这对项目无疑是个很好的维护可以有N多的OSadapter,方便移植总的来说对于开发上层应用的项目来说。

本文到这结束，希望上面文章对大家有所帮助。