• 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 Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Jeanne Boyarsky
  • Ron McLeod
  • Paul Clapham
  • Liutauras Vilda
Sheriffs:
  • paul wheaton
  • Rob Spoor
  • Devaka Cooray
Saloon Keepers:
  • Stephan van Hulst
  • Tim Holloway
  • Carey Brown
  • Frits Walraven
  • Tim Moores
Bartenders:
  • Mikalai Zaikin

About the documentation

 
Greenhorn
Posts: 13
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hi ranchers

Sorry for the delay for all of you friends that ask me about the documentation (specially Xabier y Gabriel) , I can say that it was difficult at beginning, to figure out how to structure the documentation. This is the layout of my document:

Introduction

Data tier

Network tier

Presentation tier

In each section of the document I include the problems I run into, in a very detailed way like for example:

Problem 1: How to read the database file.

I have to figure out which java class from the java.io package,
is more suitable for reading the database file ...


Solution: I think the RandomAccessFile class is more suitable for
this situation, because it allows me to read certain parts of the
file ...

That way after a lot of reviewing I came to the final documentation where I also include some littles uml class diagrams like this for example:

+------------------+
| DBAccess |
| <<interface>> |
+------------------+
| |
+------------------+
^
implements |
|
|
+-------------------+
| Data |
+-------------------+
| |
+-------------------+

Also a good tip is using the nroff unix/linux/cygwin command, which is very useful for getting you document formatted (margins, the line size etc) , which will give it an excellent presentation.

Good luck ranchers
Bye
 
Ranch Hand
Posts: 332
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Thanks for tips. I tried nroff under cygwin a it makes very nice output, I guess I'll use it before submitting.

nice documentation..
I thought, that it was all about javadoc documentation, so I started improving mine, adding @see and {@link} to javadoc comments to make it at least a bit nicer. :-)
 
I've read about this kind of thing at the checkout counter. That's where I met this tiny ad:
a bit of art, as a gift, the permaculture playing cards
https://gardener-gift.com
reply
    Bookmark Topic Watch Topic
  • New Topic