• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

(B&S) about the userguide.txt

 
Macy
Greenhorn
Posts: 26
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
>A directory called docs, containing the following items at the top level:
This html file.
...
...
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'm confusing about what I need to do the userguide.txt.
If I'm not put it online, all I need to do is place a ASCII userguide.txt file in the docs directory. Is it correct?

userguide.txt contains the instuction that how to start and use server, client, and standalone applications.

Do I need to add a link / menu of this file to my server GUI and client GUI of this instruction?

Macy
 
Surya De
Greenhorn
Posts: 28
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Macy,

I think a lot of users have gone ahead and created a Help menu in the toolbar for the app. I think that is a great idea but I think what you are doing should work fine. Just a general command line howto in the text document you are writing should work. I could be mistaken however. Can someone please clarify?

Surya
 
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 Macy & Surya,

I think the userguide should include information on
  • how to start the various modes (which should be really easy since Sun gives explicit instructions on how to do it )
  • how to perform any configuration necessary to get the application running
  • basic instructions on how to use the application
  • how to safely exit from the application
  • While this should all be self evident, the point of the exercise is for you to demonstrate to the assessor that you know how to write such documentation for real life projects where it might not be so self evident.

    If I'm not put it online ...
    For "online", think about it being available from a help menu as Surya suggest. Don't think of "online" as meaning "available over the web".

    If I'm not put it online, all I need to do is place a ASCII userguide.txt file in the docs directory. Is it correct?
    Yes, although you can also create HTML files if you prefer.

    Do I need to add a link / menu of this file to my server GUI and client GUI of this instruction?
    It is not a must requirement, but it can be nice.

    Regards, Andrew
     
    Macy
    Greenhorn
    Posts: 26
    • Mark post as helpful
    • send pies
    • Quote
    • Report post to moderator
    Thanks Andrew & Surya.
     
    • Post Reply
    • Bookmark Topic Watch Topic
    • New Topic