Hello and welcome to our community! Is this your first visit?
Register
Enjoy an ad free experience by logging in. Not a member yet? Register.
Results 1 to 2 of 2
  1. #1
    Regular Coder
    Join Date
    Feb 2005
    Location
    Tokyo, Japan
    Posts
    151
    Thanks
    0
    Thanked 0 Times in 0 Posts

    Java - project documentation standards

    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

  • #2
    Supreme Overlord Spookster's Avatar
    Join Date
    May 2002
    Location
    Marion, IA USA
    Posts
    6,280
    Thanks
    4
    Thanked 83 Times in 82 Posts
    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/Softwar...opment_process
    Spookster
    CodingForums Supreme Overlord
    All Hail Spookster


  •  

    Posting Permissions

    • You may not post new threads
    • You may not post replies
    • You may not post attachments
    • You may not edit your posts
    •