I have made a ASP.NET project on share back office
i want to start with the documentation phase now
This is my first time i am doing any software documentation
Please tell which is the best way to document a website :
What should i use :
1) UmL OR 2) DFD or 3) FLOWCHARTS or anything else
which is the best out of the three for me
and what are the differences in between them
first what is the difference between UML diagrams and FLOWCHARTS
If I should use UML then which activiy, statechart , USE CASE , SEQUENCE or DEPLOYMENT or COLLOBRATION diagrams or CLASS Diagrams
should i incorporate in my documentation
THANKS IN ADVANCE
This Question has been solved and asker verified All Experts Exchange premium technology solutions are available to subscription members.
Experts Exchange has been collecting answers to technology questions since 1996…3 million and counting! If you have a question, chances are we already have your answer.
If you can't find the exact answer you're looking for, ask our exclusive community of 50,000 experts. You’ll get a personalized answer from a trusted professional.
Thousands of free tech tips, tricks, how-to’s and tutorials are available in our peer reviewed articles section. See for yourself how smart our experts are, no login required.
Save solutions to your questions, answers you’ve discovered through searching plus helpful articles in your personal knowledgebase for easy future access.
Access the answers to your technology questions today.
30-day free trial. Register in 60 seconds.
Members of the expert community talk about why the experience at Experts Exchange is different than what you will find anywhere else.
Try it out and discover for yourself.
30-day free trial. Register in 60 seconds.
Join the community of experts here and help other tech pros by answering question in your area of expertise. You can earn FREE access to all Experts Exchange's premium features and resources.
Hi again,
"Does the project needs to have a OBJECT ORIENTED DESIGN methodology for using UML's"
No, UML can be used to model anything. It has been developed so that it can be extended to create any type of model. UML does suit Object Oriented Design but it can be used to model any idea, I think they call it "open-ended" so that you can use it for basically anything.
I think that you need to see what it is exactly you want to describe? What do you want to show using the diagrams? and Why do you want to document it? e.g: Do you want to show the overall physical architecture of the system?
Cheers,
Darren
i want to show how the process occurs in the system
what are the inputs and what are the activities that are done to convert the input to output
there are a bit of iterations in the process
i want to describe the user activities that are done in the system
and how are they linked to each
what process does every ASPX do and how is related to other pages and so on
Hi,
I would use activity diagrams to show the points made above.
You can show inputs, outputs, iterations, user interaction etc...
You could have an activity diagram for every ASPX page...
http://www.agilemodeling.c
http://www.ibm.com/develop
http://www.agilemodeling.c
Cheers,
Darren
Business Accounts
Answer for Membership
by: DarrenDPosted on 2009-02-20 at 09:11:33ID: 23693969
Hi,
There is no one particular UML diagram that you should use. I can't realy go into every document type and describe them in detail as there is plenty of material on the web already and many books written on the various diagrams.
A website in itself may not require much documentation depending on what it does and how it is built. Are you using DLL's and an n-tier application or is it simply standalone? As usual it completely depends on the project...
All I will say is that UML diagrams allow you to document/show many different views of your system and each diagram is used at a specific step within the development process. Bear in mind that each of the diagrams should be developed in conjunction with the overall documentation of the system. No one diagram will describe everything so there should be a requirements specification which states what the system should do but not how the system will do it...
Requirements Gathering - Use Case / Activity
Activity is similar to Flowchart.
Once you have your requirements then you need to design the system.
Design - Class diagrams / Interaction Diagrams (Sequence Diagram)
Then you can look at Deployment Diagrams which show the physical system.
Although UML is used to document systems it can be used to document anything really. UML is not the be all and end all they are simply tools to help you make it easier to show what you intend to do to different people within the team.
I could go on but you will have to look on the web yourself. Here are some links that might help.
http://www.ibm.com/develop
http://www.geocities.com/s
Hope this helps, cheers,
Darren