• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Help with HTML userguide

 
Fernando Franzini
Ranch Hand
Posts: 489
2
Java Spring Ubuntu
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Folks
I'll start my userguide.html and I'm completely lost....Could any rancher that did HTML help me
I've thougth about it and I'll describe this points:

1. How to run each mode (standalone, server, remote client)
2. How config each mode -> steps over GUI
3. Operations in each GUI -> with printscreens
4. Possible erros ? -> complicated stuff...I really dont know here ? invalid inputs ?
5. Create summary with link connect each parts.
I can draw some marks (like arrow or another indicators) over GUI screen to show user specific parts of GUI...

Any ideias or sugestions ?

Someone follow any simple or template that you can share with me ?
Regards
 
Johnny Barbosa
Greenhorn
Posts: 26
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I'm not going to do printsreens, I think this is unnecessary. I'm doing think like this:

-Starting the system
-Preferences
-Selecting a record
-Search records
-New record
-Edit record
-Remove record
-Menus and shortcut
-Starting the server
-Stopping the server
-Help

However, in each item above, I explain step-by-step (1, 2, 3,...) to do performing that item.
 
Roel De Nijs
Sheriff
Posts: 10662
144
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Johnny (and Fernando),

I think in a userguide you should talk about rooms (or contractors) instead of records. Because not every user is familiar with what a record is and what it represents.

Printscreens are indeed unnecessary, I made a plain text user guide. Making your gui capable of adding a new record and deleting an existing record are also unnecessary.

Kind regards,
Roel
 
Fernando Franzini
Ranch Hand
Posts: 489
2
Java Spring Ubuntu
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Johnny
I didn't provide crud operations....but thanks for you opinion
I think HTML + printscreen showing steps.....like "How to...bla bla [GUI SCREEN]" is very easily understandable to final user.
And as Master Roel told well...talk about bussines issues inside guide...not about software infra tuffs...like record etc...
Another ideias about HTML ?
 
Johnny Barbosa
Greenhorn
Posts: 26
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Roel De Nijs wrote:Making your gui capable of adding a new record and deleting an existing record are also unnecessary.

Why? Are sure about it? I think that it is necessary, because despite the sun specification not to say clearly, but your duty Interface have method to add and to delete record.

Yes, I agree with you that we must talk about rooms (or contractors)!
 
Roel De Nijs
Sheriff
Posts: 10662
144
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Johnny,

I'm 100% sure it's not needed in your gui, because I only provided search of hotel rooms and book of hotel room and I passed with a reasonable score

And my instructions tell me:

The user interface for this assignment must satisfy the following criteria:
* It must allow the user to search the data for all records, or for records where the name and/or location fields exactly match values specified by the user.
* It must allow the user to book a selected record, updating the database file accordingly.

Nothing is mentioned about creating or deleting records.

Although not used in the GUI, I did implement the create- and delete-method of the duty interface and I tested my implementation of these methods (just like all the other ones) with a JUnit test case.

Kind regards,
Roel
 
Johnny Barbosa
Greenhorn
Posts: 26
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Roel De Nijs wrote:Nothing is mentioned about creating or deleting records.

Ok. I agree with you in this point.
So, you think if to code these functionality(complete CRUD in the GUI) would be providing too much code for sun assessment?

I have ever did this CRUD in my project! I'm thinking to cut out away this functionality from my code. In my instructions also not say about DELETE and CREATE, but I implemented it too, because I think that way my project would remain better and more complete even though, that information wasn't cited clearly.
 
Roel De Nijs
Sheriff
Posts: 10662
144
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Johnny Barbosa wrote:So, you think if to code these functionality(complete CRUD in the GUI) would be providing too much code for sun assessment?

I don't say it's too much code (because I don't know how many code you needed for it). But it is not required, you won't get any extra credit for it (clearly stated in instructions.html). So you may only lose points (because it has a flaw for example) by doing it.

My advice (for everybody): keep it as simple as possible and don't spend your valuable time on things that are not required.

Kind regards,
Roel
 
Fernando Franzini
Ranch Hand
Posts: 489
2
Java Spring Ubuntu
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi folks
Another question about topic...
How deep should be user guide ? I'mean...
Do I need:
- explain how to get and intall JVM ?
- use java -jar in console mode ? and passed the aplications params ?
or just expose help for application issues ?
Regards.
 
Roberto Perillo
Bartender
Posts: 2271
3
Eclipse IDE Java Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Well, I'd say you have to include the things that the CSRs must know to operate the application, like, how to start the application, how to run the client, how to connect to the server, how to start the server, how to book rooms, etc...
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic