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

NX: User guide

 
Ulrich Heeger
Ranch Hand
Posts: 266
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi everyone,
now I finally attend the documentation phase and I'm now working at my userguide.
I want to implement it within my application as a help system. here are my questions.
I. concerning the implementation place:
I think it is recommendable to enable the access to the user guide within all my gui's (Server GUI, Clients Properties GUI (standalone and remote mode) and Main GUI). I mean, I would like to have in each gui a menu item which popups the guide.
II. My Userguide consists then of a JTree.The clicked nodes will display html-pages within an JEditorPane.
The JTree contains four main nodes:
1. How to use the Client's Properties GUI at the standalone mode.
2. How to use the Server's Properties GUI.
3. How to use the Client's Properties GUI at the remote mode.
4. How to use the Main Window.
What do you think about this approach. In what chapter do you have divided the User guide?
Thanks in advance
& greetings
Ulrich
 
George Marinkovich
Ranch Hand
Posts: 619
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Ulrich,
You're designing a Mercedes solution to a Yugo problem, but as long as you realize you're going above and beyond the call of duty, I have no problem with what you propose. In fact a user would love to use your user's guide. It sounds like it's the ultimate in flexibility and convenience.
I would cover the following topics in your user's guide:
Installation (standalone and network)
Starting the Application (standalone and network)
Using the Application
Searching the Database
Selecting a Record in the Database Table
Booking the Selected Record
Configuring the Application
It sounds like you're doing all of them already except perhaps for installation. Even though it doesn't make much sense to cover installation in an on-line user's guide, if installation isn't covered here where else will it be covered?
 
Ulrich Heeger
Ranch Hand
Posts: 266
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi George,
thank you very much for your answer.

It sounds like you're doing all of them already except perhaps for installation. Even though it doesn't make much sense to cover installation in an on-line user's guide, if installation isn't covered here where else will it be covered?

Good point. I haven't thought about that. Perhaps I should first proceed developing the html-files and I can still think about them to bind them later - if I still insist - within my JTree.
I'm thinking about to use some images like Screenshots of my GUI within my Html-files. What do you think about that?
Thanx & Greetings
Ulrich
 
Jacques Bosch
Ranch Hand
Posts: 319
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Ulrich, I agree with George.
I think you're going way over kill with the documentation.
I also wanted to do HTML or build in user guide, but realized It's going to cost me 10 to 20 hours extra work that won't get me any extra points.
So, if you're doing it for fun, go for it, but if you are doing it for points, don't waste your time.
I did a text user guide and got 100% for my documentation.
Stuff like that is good in a real world app.
Enjoy.
 
George Marinkovich
Ranch Hand
Posts: 619
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Ulrich,
Originally posted by Ulrich Heeger:

Good point. I haven't thought about that. Perhaps I should first proceed developing the html-files and I can still think about them to bind them later - if I still insist - within my JTree.

Sounds like a good strategy.

I'm thinking about to use some images like Screenshots of my GUI within my Html-files. What do you think about that?

Screenshots are fine, but they will really start pushing the size of your project jar file. I can't find it anymore, but somewhere Sun made a comment about some candidates reporting problems uploading projects larger than 500 KB. Mine was 480 KB and I had no problem.
 
Ulrich Heeger
Ranch Hand
Posts: 266
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Jacques, hi Georges,
thanks a lot for your help, your comments convinced me, I will simplify my guide
Regards
Ulrich
 
Jacques Bosch
Ranch Hand
Posts: 319
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator

I can't find it anymore, but somewhere Sun made a comment about some candidates reporting problems uploading projects larger than 500 KB. Mine was 480 KB and I had no problem.

It's on the actual upload page. But I thought it was 1MB.
Anyway. My project jar was only 258KB.
Ulrich. Glad I could help. Hope I did help.
J
 
Satish Avadhanam
Ranch Hand
Posts: 697
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi George & Ulrich
Originally posted by George Marinkovich:
Hi Ulrich,
I would cover the following topics in your user's guide:
1. Installation (standalone and network)
2. Starting the Application (standalone and network)

Second point is quite clear. Can you please explain on what do you meant by Installation?
Thanks.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic