Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

online help

 
Nate Johnson
Ranch Hand
Posts: 301
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I am trying to decide what I am going to provide as online help. By this, I mean when the user that is running the fbn client clicks the menu item for help, what should I display?
1) Just the help relevant to running the client?
2) #1 and help that would be for the grader that applies to other parts of the assignment (ex: the server, javadocs for the code, uml models, etc...)
3) Just do #1 and provide the rest of the help as html, but just mention where it is located in the README.txt file?
I guess I am leaning a bit towards #3, but what are your thoughts?
Thanks a lot!
 
Mike Piotrowski
Ranch Hand
Posts: 82
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Nate,
I included instructions for running the client and the server with some screen shots. For the client I had starting up, searching and booking. For the server just starting and stopping.
I noted the location in the README, and had a it come up in a JEditorPane from the Help menu in the client gui.
Mike
 
Michael Morris
Ranch Hand
Posts: 3451
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hey Nate,
I did pretty much the same thing that Mike did. It's a good approach and JEditorPane is easy to work with.
Michael Morris
 
Nate Johnson
Ranch Hand
Posts: 301
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks all... I ended up using the JEditorPane for online help (just for the client part) and I am going to specify the location of server help (no gui for my server) in my README.txt file.
Thanks again!
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic