PDA

View Full Version : Java - project documentation standards


Yakisoba
07-25-2006, 10:55 AM
Can anyone recommend any good websites or other resources, in regards to project documentation standards?

i.e
Flowcharts
UML
Class Diagrams

Anything other than Javadocs.

I have been "googling" the web for some time now and the majority of my results are programs that "automatically" generate some form of documentation. I do not want this.
I simply want to learn what diagrams, documents, etc. I can include throughout the development of a project to assist in project managment.

Thanks

Yak

Spookster
07-28-2006, 06:40 PM
I'm not sure what you mean by standards. There really is no standard list of documents that would go with every project. The documentation that would be needed for an individual software engineering project would depend on the nature of the project. I think what you probably need to do is to not focus on Java documentation and instead look at the software engineering process in general. The over SE process will give you an idea of what documentation is going to be involved with a SE project.

http://en.wikipedia.org/wiki/Software_development_process