Win a copy of Design for the Mind this week in the Design forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Writing choices.txt

 
Muhammad Shafique
Ranch Hand
Posts: 59
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi there,
I am working on choices.txt file. I have unorderd points realted to my decisions, problems I faced, study, discussions etc.

Now to order this stuff, which approach is better?
1- Use cases sequence OR
2- Module based documentation with 1 OR
3- Documentation according to marks distrubution OR
4- Any other approach

What about adding references in this document?

Regards,
Shafique
 
Khaled Mahmoud
Ranch Hand
Posts: 361
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
For my project I followed module based documentation, describing each main module in an independent section.I isolated other topics that did not fit into
this modular division into an independent section.
[ February 12, 2007: Message edited by: Khaled Mahmoud ]
 
Andre Winkler
Greenhorn
Posts: 5
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Does someone know: Is english the 'must' language for javadoc/comments/choices.txt ???
 
Barry Gaunt
Ranch Hand
Posts: 7729
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Originally posted by Andre Winkler:
Does someone know: Is english the 'must' language for javadoc/comments/choices.txt ???


According to the official description the language of the assignment is English. So I would say the answer to your question is yes.

I'm doing mine in approximate real english English.

Do not, repeat not, use Blinkenlights english.
[ March 09, 2007: Message edited by: Barry Gaunt ]
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic