473,471 Members | 1,728 Online
Bytes | Software Development & Data Engineering Community
Create Post

Home Posts Topics Members FAQ

One project . . . . . So much documentation!

CodeNoobster
52 New Member
Hey everyone

So I am working on my first project and have being tasked with drawing up some of the documentation for the project proposal for our client.

now after doing some research I have found that the following is essential:

-Executive Summary
-Scope of work
-Technical Plan
-Management Plan
-Commercial Plan
-Appendices

how ever I have also seen these documents aswell:

-SQAP
-SCMP
-STD
-SRS
-SVVP
-SDD
-SPMP
-SUD
-WBS

and, in addition to this I have found that fishbone diagrams are also needed for the proposal

now please understand that i am a programmer and have a relatively small background in documentation, so my question is what documentation is needed exactly for a project proposal? and how are the other documents intergrated into the proposal or are they seperate?

and what diagrams are to be included in the proposal and for what purpose exactly?

thanks in advance guys
May 17 '14 #1
0 919

Sign in to post your reply or Sign up for a free account.

Similar topics

1
by: Sasa Tomicic | last post by:
Hello! Currently C# supplies us with the support for auto generating of the comment web pages (project documentation) through the IDE option "Tools/Build Comment Web Pages...". But what about...
14
by: copyco | last post by:
Can anyone tell me what the purpose is to adding items such as a VBScript file or HTML document to your VB.NET project? Once you have these things added, how to you access them and use them in...
0
by: Bob Hanson | last post by:
Hello All, Does Microsoft have something planned in the near future to generate documentation for a VS project? I company I now work for is using VB.Net instead of C# so I wanted to check as...
2
by: Lloyd Dupont | last post by:
How do you XML document namespace? I'm tetsing my project documentation with NDoc. And I could see I have no namspace documentation. How do I fix that?
1
by: sandhya rani | last post by:
Dear Forum Members, I request all of u to pls Give me some details or websites where i can get unix related project documentation which has to be mainly based on...
1
by: aartiP | last post by:
Hello. I am a php developer and currently having a vast project in hand of a portal development. I want to do it neatly with planning and full fledged documentation. can anybody help me providing...
0
by: chandra9560 | last post by:
Hello Guys...... I've two project in one solution project1 and project2. I've fit the panel1 in project1 so i want to show on prj2 any data just like TextBox or level on project1(panel1). How to...
0
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can...
0
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers,...
1
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows...
0
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each...
0
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing,...
1
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new...
0
by: conductexam | last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and...
0
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
0
by: 6302768590 | last post by:
Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated ...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.