如何记录软件开发项目 [英] How to document a software development project

问题描述

我要开始研究一个新项目。有史以来最大的l。我包括;流程图，DFD？关于如何最好地记录这个的任何线索？



Thnx



Ronald



我尝试了什么：



我过去开发过基本文件。我觉得它不适合这个。

解决方案

读这个 -

软件文档 - 维基百科 [ ^ ]



您可以创建多种类型的文档 -

1）业务需求文档 - 项目图

- 这包含客户要求和软件的建议模型（粗略工作，可能是伪代码）

2）技术文档 - 实际代码和截图

- 这包含实际的软件代码及其详细信息，应用程序的屏幕截图

3）用户指南 - 如何使用此应用程序？

- 这是给最终用户的想要使用你的软件，他们应该知道你的应用程序的功能以及如何使用它以及你的应用程序的限制



4）测试用例文件

- 这是让你的测试团队让他们知道如何测试这个软件

用户指南可以参考这个，但单独的文档会增加优势

I'm to start working on a new project. the biggest l have ever undertaken. Do l include; flow diagrams, DFD? Any leads on how best to document this?

Thnx

Ronald

What I have tried:

I have developed basic documents in the past. I however feel it is not suitable for this.

解决方案

read this -
Software documentation - Wikipedia[^]

There are many types of documents you can create -
1) Business requirement document - plot of your project
- this contains client requirement and proposed model of your software (rough work and may be pseudo code)
2) Technical document - Actual code and screenshot
- this contains actual software code and its details , screenshots of your application
3) User guide - how to use this app?
- this is for your end user who wants to use your software, they should know features of your application and how to use it and also limitation of your app

4) Test case document
- this is for your testing team to let them know how to test this software
user guide can be reference for this, but separate documentation would be added advantage

这篇关于如何记录软件开发项目的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！