Professional way to write project documentation

Posted by EugeneP on Stack Overflow See other posts from Stack Overflow or by EugeneP
Published on 2010-05-13T06:31:13Z Indexed on 2010/05/13 6:34 UTC
Read the original article Hit count: 184

Filed under:

java

|

j2ee

|

documentation

|

uml

What tools and standards do you use to describe your project, database, modules, classes, their interaction for programmers, let's say after the project is finished.

Do you use UML?

Are there enterprise standards for Java developers, how to write such a documentation let's say from SUN?

Are there specific tools that simplify this documentation process & compilation of neccessary docs.

If there are good books on project documenting process, 
please give me links to Amazon.

© Stack Overflow or respective owner

Related posts about java

Tomcat 6: Access Control Exception?

as seen on Server Fault - Search for 'Server Fault'
I'm trying to setup a tomcat6 server, and I'm trying to match another setup someone else established. However, my deployment (default Ubuntu install) uses a policy.d/ directory structure, and the established server just uses a catalina.policy file. I've tried setting every entry in policy.d to match… >>> More
Problem in creation MDB Queue connection at Jboss StartUp

as seen on Stack Overflow - Search for 'Stack Overflow'
I am not able to create a Queue connection in JBOSS4.2.3GA Version & Java1.5, as I am using MDB as per the below details. I am putting this MDB in a jar file(named utsJar.jar) and copied it in deploy folder of JBOSS, In the test env. this MDB works well but in another env. [ env settings and… >>> More
failing to establish connection between Postgres db and gwt

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, I am using Postgres and gwt 2.0 for one of my applications. I am facing problem connecting to the database. When I try to connect it gives "ClassNotFoundException". Here is what I get when I try to connect to database: java.lang.ClassNotFoundException: org.postgresql.Driver at java.net… >>> More
failing to establish connection between postgre db and gwt

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, For i am using postgre and gwt 2.0 for one of my applications. I am facing problem connecting to the database. When i try to connect it gives "ClassNotFoundException". Here is what i get when i try to connect to database: java.lang.ClassNotFoundException: org.postgresql.Driver at java.net… >>> More
Migration and deployement problems JBoss 4.2.2.GA to JBoss 6.0.0.M2

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, I'm trying to migrate an application running on JBoss 4.2.2.GA to JBoss 6.0.0.M2 I give you some log to explain my problem : boot.log : 2010-03-16 09:59:29,406 ERROR [org.jboss.system.server.profileservice.ProfileServiceBootstrap] (Thread-2) Failed to load profile: Summary of incomplete deployments… >>> More

Related posts about j2ee

Java EE 6????????????????! ??????????????????????J2EE??????????J2EE??????JavaOne Tokyo 2012?????

as seen on Oracle Blogs - Search for 'Oracle Blogs'
Java EE???????Java EE???????????????·????????????Core J2EE Patterns(J2EE????)?????????????????????10???????????????? “????????????”?????????????Java EE??????6?????????WebLogic Server?????????????·???????????????J2EE???????????????????????????????2012?4???????JavaOne Tokyo 2012??????????Java EE 6?… >>> More
Project based on J2EE

as seen on Stack Overflow - Search for 'Stack Overflow'
Would you start J2EE project nowadays if you have other alternatives? UPDATE: I think little clarification is needed: Is it worth investing in J2EE if practically everything it claims to offer can be achieved by using other technologies? To be honest, J2EE scares me by its monstrosity and I foresee… >>> More
Noftification between J2EE components.

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi There! I have a design problem . My application has multiple J2EE components ,In simple terms one acts as a service provider(Non UI) and others are consumers(UI webapp) . The consumer gets the configuration data from the service provider(this basically reads the data from DB) during the start… >>> More
Notification between J2EE components.

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi There! I have a design problem . My application has multiple J2EE components ,In simple terms one acts as a service provider(Non UI) and others are consumers(UI webapp) . The consumer gets the configuration data from the service provider(this basically reads the data from DB) during the start… >>> More
Jdeveloper vs java/j2ee/js+extjs ?

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi All, i am new to the web development environment, having came from a unix/c environment. i've been recently asked to create a web app, which i thought would require postgresql, java/j2ee, and javascript for the client interface. as i had wanted a nicer gui, i've been reading up on extjs, which… >>> More