• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Sample choices.txt and userguide.html

 
Kannan Ekanath
Greenhorn
Posts: 18
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
No I am not asking for blatant answers. I am doing the Bodgitt and Scarper LLC application and I have written my choices.txt and userguide.html

I wanted to know if someone has some sample formats of choices.txt and userguide.html that I could compare it with (preferably for a different problem). I feel my documentation is being too lengthy and heavily formatted and I would like to know what other people have done in this regard
 
mohamed sulibi
Ranch Hand
Posts: 169
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
hi;

i am writing my choices.txt as i will understand it when anyone give it to me from architectural design to low-level description and notes in the classes.

regards.
 
Jeffry Kristianto Yanuar
Ranch Hand
Posts: 759
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
For the userguide, I used text files. The format is like this :

to book a room --> bla-bla-bla
to search for rooms --> bla-bla-bla
to connect to a database --> bla-bla-bla

I also documented the troubleshooting


For the choices.txt, I documented in every package section.


After all, the format is not matter as long as it is informative enough for the assessors.

Good Luck !!!

Jeffry Kristianto Yanuar (Java Instructor)
SCJP 5.0, SCJA, SCJD (UrlyBird 1.3.2)
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic