Win a copy of Re-engineering Legacy Software this week in the Refactoring forum
or Docker in Action in the Agile forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Documentation and User Guide Standards

 
Khaled Mahmoud
Ranch Hand
Posts: 361
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
 
Jeroen T Wenting
Ranch Hand
Posts: 1847
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 361
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 918
IntelliJ IDE Java Linux
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

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

Regards M
 
Edward Chan
Greenhorn
Posts: 3
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

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.


Cheerz,
Ed
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic