• Post Reply Bookmark Topic Watch Topic
  • New Topic

How to provide user documentation?

 
Murphy Patrick
Greenhorn
Posts: 11
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
The instructions say this about user documentation:
"You should also provide basic user documentation. This should be sufficient to allow a user who is familiar with the intent of the project to use the application. If you wish, appropriate parts of the user documentation may be provided on-line."
I am planning to create a static HTML file which has some basic user documentation.
Is it enough to meet the above requirement?
I haven't planned to integrate it with the UI [through a Help menu option]. Is providing a static HTML file enough?
Thanks.
 
Mark Spritzler
ranger
Sheriff
Posts: 17309
11
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
It is enough, however, making it an option on your GUI via a menuItem is very easy.
There is a post here that I even got my code from for displaying the HTML help. I just can't find it.
Mark
[This message has been edited by Mark Spritzler (edited November 09, 2001).]
 
I want my playground back. Here, I'll give you this tiny ad for it:
the new thread boost feature: great for the advertiser and smooth for the coderanch user
https://coderanch.com/t/674455/Thread-Boost-feature
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!