Hi All,
I'm looking for documentation templates and examples to be used during the project development life cycle.
System Analysis
System Architecture
Detail Design
Thanks a lot.
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 Darren,
Tnx alot for the response.
I'm looking for a set of actual document templates (skeleton) to be filled with the analysis/design results.
Actual real examples will be a very good start pack for accelerating the documentation stage of each and every step in the project development life cycle.
Tnx in advance.
Guy
Hi Guy,
Unfortunately I don't know where you will get templates for the analysis, design and implementation phases. I suppose this can depend on the methodology that you want to use. You might have to buy a book in order to get the templates you desire. Obviously you can make up you're own templates but it depends on what methodology you use. I don't think that there any exact rules. It depends on you're own development process. What methodology are you using?
OO Methodology
RUP Methodology - http://www.ibm.com/develop
Waterfall
Other Documents I found...
http://www.experts-exchang
http://www.literateprogram
Maybe someone could give you theirs... and you could take what you want from theirs.
Hope this helps,
Darren.
Hi Guy,
I think that you may be getting you're wires crossed. UML is not a methodology for developing software. It is simply a tool that enables you to use diagrams to communicate your analysis and design to other people.
UML has certain diagrams to show different views of the software system.
ie
There are 'Use Case' diagrams and 'Activity' diagrams that are used in conjunction with 'Use Case Specifications' that communicate what functionality end users will be able to perform etc... 'Requirementes'
Then there are analysis and design diagrams such as Class diagrams and interaction diagrams eg Sequence diagram or Collaboration diagrams. 'Analysis and Design'
I'm still not sure what you are going for as you seem a little uncertain yourself, Maybe you should have a look at
The Object Management Group (OMG) and Model Driven Architecture (MDA). This could be what you are looking for... though it is not a methodology. It may seem like a methodology but it used with a methodology of choice.
Some people have applied the MDA approach to Agile Software Development Methodology others use the Rational Unified Process. Some use their own form of iterative methodology.
It's a matter of choice,
Sorry I can't be of more help but keep asking questons and I'll try to help as much as I can.
Cheers,
Darren
http://www.omg.org/getting
Hi Darren,
Yes indeed, UML is only a system analysis methodology.
However, I'm looking for documentation templates that use the analysis results (including the diagrams you mentioned) and more sections that elaborate the analysis result and finally provide a detail design for analysed system.
Please let me know if still I'm out of boraders :)
Tnx for your efforts,
Guy
Hi Guy,
Seems like we are getting our wires crossed now.. :)
Are you saying that you want to create you're analysis models and then convert them into documentation as in
Functional Area
Class Name
Attributes
Operations
Who instantiates who etc...
So that you can describe the functionality to be contained within the system?
Can you explain what documentation you wish to get from you're analysis models in UML?
Darren
Hi Darren,
Exactly!!
Well, I had some problems describing the actual need :(
Anyway, I'm using Enterprise Architect for the entire analysis and design life cycle.
I want to generate word documents that will capture the results of the entire analysis and design stages to be delivered to development team.
I have a general idea of how it should loot like, but I wanted to get some references to actual used word document templeates for documenting the entire development life cycle.
Please advice if you have such, or can refere me to...
tnx
Guy
Hi Guy,
Well, firstly I have not used Enterprise Architect as a UML tool, I have used IBM Rational Software Architect but this tool does not allow you convert you're models into a document like you require. It does create a document containing all of the models but this is not what you are looking for.
You could probably write a transformation yourself in order to get this to work but it would take quite a while. I'm not sure where you would even start.
All I can say is that after you have created the architecture and design models these should be given to the developer so that they can create the required code bodies from the actual model. I don't really see any point in converting them back into a word doc, that is after all what the models are in the first place. The documentation...
I don't know where you will find templates, I'd just open word and create my own.
Sorry I can't be of any more help but I'm not sure you'll get what you require from here. Let me know if you find a solution as I'd be interested to know.
Cheers,
Darren
Business Accounts
Answer for Membership
by: DarrenDPosted on 2008-08-25 at 08:36:35ID: 22306360
Hi,
Just wondering...
Documentation on using UML?
Documentation as in Use Case Specifications, that say what a use case is going to do?
This depends on what it is exactly you are trying to do. Are you trying to create a project using MDA? Do you just want general guidelines? Do you want a book or a web site?
The areas you mentioned below are pretty much the headings for each chapter of you're documentation. The only one you might add would be requirements.
System Analysis
System Architecture
Detail Design
Need a bit more info...
Darren