Clear, concise documentation for a small application


DevX Home    Today's Headlines   Articles Archive   Tip Bank   Forums   

Results 1 to 3 of 3

Thread: Clear, concise documentation for a small application

  1. #1
    Geo Guest

    Clear, concise documentation for a small application


    I have just finished an application and wish to document it.
    I am not familiar with formats, styles of application docs for java.

    I wish to list the functions of the application, then, follow the sequence
    of classes/methods within the functions.

    This listing of classes and methods in order of execution is very lenghty
    and tedious; a pain for the programmers to follow. Flow diagrams come to
    mind, but I'm not sure of the level of detail necessary.

    I am looking for a format that is high-level enough to be concise, but detailed
    enough to be useful for later modifications.

    Any suggestions, format examples?

    Thank you,

    Geo



  2. #2
    Ako Guest

    Re: Clear, concise documentation for a small application


    Its all been taken care of by java folks, you can use javadoc to create documentation
    exactly the way java documentation is done. look at sun's website for a simple
    and straight forward tutorial, or any good book.

    Ako


    "Geo" <gkozel@allstate.com> wrote:
    >
    >I have just finished an application and wish to document it.
    >I am not familiar with formats, styles of application docs for java.
    >
    >I wish to list the functions of the application, then, follow the sequence
    >of classes/methods within the functions.
    >
    >This listing of classes and methods in order of execution is very lenghty
    >and tedious; a pain for the programmers to follow. Flow diagrams come to
    >mind, but I'm not sure of the level of detail necessary.
    >
    >I am looking for a format that is high-level enough to be concise, but detailed
    >enough to be useful for later modifications.
    >
    >Any suggestions, format examples?
    >
    >Thank you,
    >
    >Geo
    >
    >



  3. #3
    Leonardo Kasperavicius Guest

    Re: Clear, concise documentation for a small application

    Or you can use too the Poseidon for UML, it's free and Java compatible.
    http://www.gentleware.com/products/download.php3

    Leonardo Kasperavicius


    "Ako" <ays73@hotmail.com> escreveu na mensagem
    news:3b8bd8a2$1@news.devx.com...
    >
    > Its all been taken care of by java folks, you can use javadoc to create

    documentation
    > exactly the way java documentation is done. look at sun's website for a

    simple
    > and straight forward tutorial, or any good book.
    >
    > Ako
    >
    >
    > "Geo" <gkozel@allstate.com> wrote:
    > >
    > >I have just finished an application and wish to document it.
    > >I am not familiar with formats, styles of application docs for java.
    > >
    > >I wish to list the functions of the application, then, follow the

    sequence
    > >of classes/methods within the functions.
    > >
    > >This listing of classes and methods in order of execution is very lenghty
    > >and tedious; a pain for the programmers to follow. Flow diagrams come to
    > >mind, but I'm not sure of the level of detail necessary.
    > >
    > >I am looking for a format that is high-level enough to be concise, but

    detailed
    > >enough to be useful for later modifications.
    > >
    > >Any suggestions, format examples?
    > >
    > >Thank you,
    > >
    > >Geo
    > >
    > >

    >




Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  
HTML5 Development Center
 
 
FAQ
Latest Articles
Java
.NET
XML
Database
Enterprise
Questions? Contact us.
C++
Web Development
Wireless
Latest Tips
Open Source


   Development Centers

   -- Android Development Center
   -- Cloud Development Project Center
   -- HTML5 Development Center
   -- Windows Mobile Development Center