• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Liutauras Vilda
  • Bear Bibeault
  • Junilu Lacar
  • Martin Vashko
Sheriffs:
  • Jeanne Boyarsky
  • Tim Cooke
  • Knute Snortum
Saloon Keepers:
  • Ron McLeod
  • Tim Moores
  • Stephan van Hulst
  • Tim Holloway
  • Carey Brown
Bartenders:
  • Scott Selikoff
  • salvin francis
  • Piet Souris

How to prepare java project technical documentation

 
Greenhorn
Posts: 1
  • Likes 1
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I need to prepare java project technical documentaion.Can U please send me the template or any guide.

Thanks in advance.
 
author
Posts: 14112
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Who is the audience you will be doing the documentation for?
 
(instanceof Sidekick)
Posts: 8791
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi, welcome to the ranch!

Questions about what kind of documentation to prepare, who does it, when and so on come up fairly often. I changed the dropdown on the forum page to view postings from the last 60 days instead of 10 days and found a couple. Browse through those for anything about documents, requirements, specs.

In short, documents are created to communicate something. You have to know in pretty good detail who is going to read it, what they want to learn and what they're going to do with it. If you can answer those, the doc will write itself. Or sometimes you can just walk over and talk to the interested parties and save a lot of typing.
 
Greenhorn
Posts: 14
Eclipse IDE Firefox Browser Windows Vista
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
So I need a pattern or template of technical documentation to be implementeted in our projects. Do anybody know anything ?


I also use Java and J2EE.
 
Marshal
Posts: 14510
240
Mac Android IntelliJ IDE Eclipse IDE Spring Debian Java Ubuntu Linux
  • Likes 1
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I have adapted Simon Brown's outline for a "Software Guidebook" as supplementary documentation for my projects. I put all that in a project wiki.

https://leanpub.com/software-architecture-for-developers

Parts V and VIII of the book go into the details of what goes into the Software Guidebook. Not sure if this is what you're looking for though.
 
Beauty is in the eye of the tiny ad.
Java file APIs (DOC, XLS, PDF, and many more)
https://products.aspose.com/total/java
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!