• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Documentation

 
Nandini Sriram
Ranch Hand
Posts: 132
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hai,
I have some questions in user-documentation. I plan to include a summary of my design, major design decisions etc. What I want to know is this -
1. Should the user-guide(online help) be separate from this documentation, or can it be a part of it?
2. If I decide to have the "help file" (user guide)online, should it be like a HTMLfile or can I open another window and put this in there, so that when the user clicks on 'help', this window is going to open.
Thanks
Nandini
[ August 21, 2003: Message edited by: Nandini Sriram ]
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12014
220
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Nandini
I believe user documentation should be separate from the design decisions documentation. If this was real life, they could be (and probably would be) going to two totally different groups.
2. If I decide to have the "help file" (user guide)online, should it be like a HTMLfile or can I open another window and put this in there, so that when the user clicks on 'help', this window is going to open.

How you do that is up to you. I had a separate window for displaying online help.
Regards, Andrew
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic