• Post Reply Bookmark Topic Watch Topic
  • New Topic

where should i place my user manual ?  RSS feed

 
frank meng
Greenhorn
Posts: 19
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
i write a user manual which describes the meaning of each button in GUI and how to use them.I make it on-line as well.
But I doubt where i'd place it? In readme.txt? In assignment,there are no such topic listed in the content of readme.
Or shall i put it alone with readme?
 
Mark Spritzler
ranger
Sheriff
Posts: 17309
11
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
If you have it online in the Help Menu, then that is all you need. It is not part of the readme.txt.
Mark
 
Jeff Song
Greenhorn
Posts: 27
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
My server has no GUI so is it need user document?
where to put it, in help menu or in a solo dir?
 
Mark Spritzler
ranger
Sheriff
Posts: 17309
11
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Well you can write in your readme.txt where to find the html document that is your help for the server.
Mark
 
Matt Ghiold
Ranch Hand
Posts: 213
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Can we just place all our user documentation on a web server? Or does it have to be displayed within the application?
I'd love to just stick the docs for user the application on my Linux box, and not have to
worry about it.
Thoughts?
-Matt
 
It is sorta covered in the JavaRanch Style Guide.
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!