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

User documentation

 
Liviu Carausu
Ranch Hand
Posts: 159
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi everybody,

I quote from my specifications :

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.


What is the catch here ? Do you think that I lose points if I deliver the user documentation only as HTML ?

Thanks,
Liviu
 
Roberto Perillo
Bartender
Posts: 2271
3
Eclipse IDE Java Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Howdy, Liviu!

Do you think that I lose points if I deliver the user documentation only as HTML ?


No. You have to choose one of the 3 ways to provide instructions to your users. This is the user guide, so if you provide instructions about how to use the application you developed, it should be ok. I chose to create only a plain text user guide, but the main point is to provide instructions about how to use your application in this document.
 
Liviu Carausu
Ranch Hand
Posts: 159
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Roberto Perillo wrote:
No. You have to choose one of the 3 ways to provide instructions to your users. This is the user guide, so if you provide instructions about how to use the application you developed, it should be ok. I chose to create only a plain text user guide, but the main point is to provide instructions about how to use your application in this document.


Hi Bob,
Thank you very much for your answer. I can spare some time by not making the help system.
Liviu.
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic