• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

a problem about documentation

 
Vince Cheung
Greenhorn
Posts: 16
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
You must provide basic user documentation. This should be sufficient to allow a user who is familiar with the broad purpose of the project to use the application. This documentation must be in one of these three formats:
�HTML
�Plain text (not a wordprocessor format)
�Within the application as a help system.

Is this doccumentation "choices.txt", "userguide.txt" or another?
thanks
 
Dieskun Koper
Ranch Hand
Posts: 85
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
The user documentation is the user's guide (userguide.txt in case of plain text). Check the last point in the "Packaging of Submissions" section.
 
Nicholas Cheung
Ranch Hand
Posts: 4982
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
You need to write 2 documents:
- choice.txt, which is your design documentation
- userguide.txt (or HTML), which is the user guide of your system.

Nick
 
Jim Janssens
Ranch Hand
Posts: 210
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
But you do not need to provide the userguide.Txt (or html) if you provide the help system inside your application, right ?
 
Dieskun Koper
Ranch Hand
Posts: 85
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Right. Note the "in one of these three formats" in the instructions.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic