• Status: Solved
  • Priority: Medium
  • Security: Public
  • Views: 233
  • Last Modified:

Project Documentation

I am preparing a project documentation. The project involves
 compression and encryption algorithms, and transmission of data
using the IPX protocol.
I have a few doubts about the documentation.

I need to explain in the documentation
1)what algorithms i use for compression/encryption
2)why i have chosen the algos.
3)how they should be done.

same goes with protocol.

Do i put 1,2 in Analysis and 3 in design.
 or
do i have to put all 1,2,3 in Design.

( i know some of u might think,i shuld know better having done the project.It is only a student project so i did not follow the exact
cycle. i just want to know the conventions used in the documentation
when we use standard algos and protocols)

hoping to get some early replies coz i am nearing the deadline
 for submission
0
radhu
Asked:
radhu
  • 2
  • 2
  • 2
  • +1
1 Solution
 
KocilCommented:
The general process stage are:
analisys  -> know the problem
design  -> propose the solution
implementation -> realize the solution


So I think:
1,2 -> design
3   -> implementation, or detailed design

0
 
havman56Commented:
point 2 --- why u chosen algorithm is the analyis
point 1  - what r the algorithm u used is highlevel design( HLD)
point 3- how they should be doen is LLD( low level design)


i hope this will solve ur problem.

havman
0
 
bkrahmerCommented:
Kocil, what you are describing is one development method.  There are alternative methods which think completely outside of that box.  Extreme Programming is one great example.  Check it out sometime.

brian
0
Independent Software Vendors: We Want Your Opinion

We value your feedback.

Take our survey and automatically be enter to win anyone of the following:
Yeti Cooler, Amazon eGift Card, and Movie eGift Card!

 
havman56Commented:
aditional info  extreme programming needs more stage gate reviews  is it so?
0
 
bkrahmerCommented:
I can't explain XP in a paragraph, because it's already explained in books and websites.  Check out http://www.extremeprogramming.org/  You can get a feel for it in about 10 minutes.

brian
0
 
KocilCommented:
I have read the website.
Yeah, XP is good when you are doing a project that always changes.
But here we are talking about writing a documentation, after the project is offer. The issue is how to systimatically put the right information on the logically sequenced chapters. I think the classic flow is more appropriate.
0
 
radhuAuthor Commented:
thanku kocil,havman56 and bkrahmer for ur suggestions.
0

Featured Post

Concerto's Cloud Advisory Services

Want to avoid the missteps to gaining all the benefits of the cloud? Learn more about the different assessment options from our Cloud Advisory team.

  • 2
  • 2
  • 2
  • +1
Tackle projects and never again get stuck behind a technical roadblock.
Join Now