Win a copy of The Business Blockchain this week in the Cloud forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Silly quistion about user guide

 
Hanna Habashy
Ranch Hand
Posts: 532
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
hi:
My instruction states:

User documentation for the database server and the gui client. If your user documentation is online then you may omit this file.

I posted the user guide on the web in PDF formate. I wonder PDF is ok, or it must be in HTML format.
Also, it states that I may omit this file, then where can I mension that the user guide is online?
thanks
[ June 10, 2004: Message edited by: Hanna Habashy ]
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12007
215
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Hanna,

If you take a look earlier in your instructions, you should have something to the effect of:


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:
  • [list]HTML
  • Plain text (not a wordprocessor format)
  • Within the application as a help system.



  • The section you quoted is in the "deliverables" section, and I believe that when they say that the documentation is allowed to be "online", they (in the context I quoted above) mean that the documentation is allowed to be "Within the application as a help system".

    I think that using the literal meaning of "online" as meaning "on the web somewhere", could lead to failure, and then you would end up in an argument with Sun as to what "online" really means. I just wouldn't even risk it.

    Even if you disagree with that, PDF is not one of the three allowable formats.

    Regards, Andrew
     
    Hanna Habashy
    Ranch Hand
    Posts: 532
    • Mark post as helpful
    • send pies
    • Quote
    • Report post to moderator
    hi Andrew :
    I am not trying to argu or anything. The following is the exact quote form my instructions.

    User documentation for the database server and the gui client. If your user documentation is online then you may omit this file. However, if the documentation is not online, you must provide either a single plain ASCII (not word processor format) text document, which must be called userguide.txt, or multiple HTML files which must all be accessible from a starting point document that must be called userguide.html.


    It state if it is online, I may omit this file..!!
    what doesn that exactly mean??
    and if it is not online, I must provide it in .txt or html format.

    I have just upload it anyway, so there is nothing I can do but wait and see.
    I don't want to fail for a stupid reason. I put it on the web, because I want to add screen shots, and it is larg size.
    I don't mind to fail, but at least for a good reason.
    just wish me luck.
     
    Javini Javono
    Ranch Hand
    Posts: 286
    • Mark post as helpful
    • send pies
    • Quote
    • Report post to moderator
    Hi,

    Quote:

    User documentation for the database server and the gui client. If your user documentation is online then you may omit this file. However, if the documentation is not online, you must provide either a single plain ASCII (not word processor format) text document, which must be called userguide.txt, or multiple HTML files which must all be accessible from a starting point document that must be called userguide.html.


    I always assumed that online meant on the web, and that it was an option for those who wanted
    to create a user's manual with screen snapshots.

    However, after reading Andrew's comments above, Andrew probably is correct, wherein
    "online" means that the help system exists within the application itself. [Of course, to
    say that the application has an "online" help system makes little sense to me because
    the application can run in local mode, but then again, Sun's instructions rarely make
    sense to me.]

    But, as usual, does anyone really know? Since no one appears to know with certainty,
    Andrew is probably also correct in ascertaining that to put the user's guide on the
    web increases one's risk of failure or of losing points.

    The only reason that I decided not to put my user documentation on the web, is
    because it is always possible that the "web may go down", then how would the
    examiner read my manual. So, I felt it safer to submit everything directly to
    the examiner, even if I had a choice to put the user's manual on the web. Also,
    the user interfaces are not that complicated, and I figured they could just as
    easily be described using plain text as with pictures.

    Good luck on your exam, and let us know how this issue resolved itself.

    Thanks,
    Javini Javono
     
    • Post Reply
    • Bookmark Topic Watch Topic
    • New Topic