Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

About the documentation

 
Pablo Aravena
Greenhorn
Posts: 13
  • Mark post as helpful
  • send pies
  • 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
 
John Stone
Ranch Hand
Posts: 332
  • Mark post as helpful
  • send pies
  • 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. :-)
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic