Forums Register Login

User documentation

+Pie Number of slices to send: Send
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
+Pie Number of slices to send: Send
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.
+Pie Number of slices to send: Send
 

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.
This is my favorite show. And this is my favorite tiny ad:
a bit of art, as a gift, the permaculture playing cards
https://gardener-gift.com


reply
reply
This thread has been viewed 915 times.
Similar Threads
Read file from Jar - Exception
User guide question
a problem about documentation
userguide.txt file
Is one userguid.txt enough for all those sections.
More...

All times above are in ranch (not your local) time.
The current ranch time is
Mar 28, 2024 14:57:33.