How to document a software development project

Question

0.00/5 (No votes)

See more:

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.

Posted 25-Feb-18 20:03pm

Member 13493077

Updated 25-Feb-18 23:25pm

Add a Solution

Comments

CHill60 26-Feb-18 3:25am

It depends on what the boss or client wants, what development model you will be using (Agile, Waterfall, Custom), Team involved or just individual ...many factors

1 solution

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

RDBurmon · Answer 1 · 2018-02-25T23:26:00

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