• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

What's supposed to be in the userguide.txt?

 
b weiss
Greenhorn
Posts: 7
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I've finished all my design, coding, and testing and am in the process of packaging my project for submission. I was wondering if I'm correct in assuming that the only thing that needs to be in the userguide.txt is how the use the GUI and how to use the server? Is there anything else. All the design choices are documented in the choices.txt file but I just wanted to make sure I covered everything! Any help would be greatly appreciated thanks!!!
 
Jeffry Kristianto Yanuar
Ranch Hand
Posts: 759
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
In my assignmet, I put the following things in my userguide.txt :
- How to start the client
- How to start the server,
- How to start the stand-alone client.
- How to book and unbook the reservation (my assignment was URLyBird)
- The simple troubleshooting


Good luck !!!

Jeffry Kristianto Yanuar SCJP, SCJA, SCJD
 
K. Tsang
Bartender
Posts: 3583
16
Android Java
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
b weiss wrote:I've finished all my design, coding, and testing and am in the process of packaging my project for submission. I was wondering if I'm correct in assuming that the only thing that needs to be in the userguide.txt is how the use the GUI and how to use the server? Is there anything else. All the design choices are documented in the choices.txt file but I just wanted to make sure I covered everything! Any help would be greatly appreciated thanks!!!


Hi B,

You are correct. The user guide is a user manual describing how to set up and use the client and server. I used html so that I can have screen shots for windows and errors etc.
 
b weiss
Greenhorn
Posts: 7
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Awesome! Thanks so much!
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic