File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Documentation and User Guide Standards Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "Documentation and User Guide Standards" Watch "Documentation and User Guide Standards" New topic

Documentation and User Guide Standards

Khaled Mahmoud
Ranch Hand

Joined: Jul 15, 2006
Posts: 361
I have finished working on the Sun Certified Java Developer
programming assignment and now i want to start writting both
the (choices.txt) and the userguide.

Is there a standard i can follow in writting both forms of documentation.

Life is the biggest school
Jeroen T Wenting
Ranch Hand

Joined: Apr 21, 2006
Posts: 1847
You should really have started writing your choices.txt at least during development, while you were making those choices.

AFAIK there's no fixed format to follow. If there had been it'd have been documented as a MUST requirement in your assignment text after all.
Just make sure your user documentation is feature complete and can be understood by non-technical people (end users) and your choices.txt is complete (documents everything) and can be understood by English speaking natives.
Both should of course be set in syntactically and gramatically correct English.

Khaled Mahmoud
Ranch Hand

Joined: Jul 15, 2006
Posts: 361
Actually i used to write notes while developing the project.I meant by my question is a standard way of organizing and presenting these data as in real world projects.
Mihai Radulescu
Ranch Hand

Joined: Sep 18, 2003
Posts: 918


I use bullets, so I have a list of them.

Regards M

Edward Chan

Joined: Nov 18, 2006
Posts: 3

how much do you guys write in your "choices.txt".

if you have used bullets/lists, how many of them do you have?

I currently have about 6 points. Some of them don't even know if i should put there.

It would be good to know, get a comparison or something.

I agree. Here's the link:
subject: Documentation and User Guide Standards
It's not a secret anymore!