• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

how do you people plan to give the source files

 
Siddharth Mehrotra
Ranch Hand
Posts: 185
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
this is the way i have deceided as of date.
there will be a root jar file that will have the following
1> The two jar's server.jar and client.jar containing only the class files.
2>There will be a suncertify directory which will have db,server and client as its sub directories. these sub-directories will have all the source code.
3>a docs directory that will have the javadocs in it
4> README.txt
5> db.db file.
6> policy.txt
 
Mark Spritzler
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
That sounds very good. Where are the User documentation for the client and the server?
Mark
 
Bal Sharma
Ranch Hand
Posts: 273
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hello Siddharth:
Looks good. I believe you have DesignChoices document somewhere else. Do not forget to mention it whereever it is (location)in you README.txt.
-Bal
 
Siddharth Mehrotra
Ranch Hand
Posts: 185
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Originally posted by Mark Spritzler:
Where are the User documentation for the client and the server?
Mark

what do you mean by that. I have GUI on the clinet side only and i have an online help for the user in the gui itself. Do i have to provide something else also
 
Siddharth Mehrotra
Ranch Hand
Posts: 185
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Originally posted by Bal Sharma:
I believe you have DesignChoices document somewhere else. Do not forget to mention it whereever it is (location)in you README.txt.
-Bal

Thanks bal i almost forgot about it. I'll be putting the designChoices document in the root also and will give its path in README.txt.
thanks
 
Mark Spritzler
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
What I meant was that in your original post of 6 things User documentation was not one of them.
1. class files
2. source code
3. Javadocs
4. readme.txt
5. db.db file
6. policy.txt
no clientuserdoc.html or serveruserdoc.html or something like that, I just wanted to make sure you didn't forget anything, andt hat was the only thing that popped up in my mind.
Mark
 
Siddharth Mehrotra
Ranch Hand
Posts: 185
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
hi mark,
well i did not add user documentation cos the sun's specs says that the documentation can be online ( and here is where the problem starts)
see for my application i have GUI only on the client side and for that i have provided online help(that is through the help menu in the Clinet GUI). and for the server there is no GUI.
now tell me what do i do.
 
Mark Spritzler
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Whenever I hear online, I alsways think it is on the internet. I had an html User docuemtnation that displayed when the user selected Help from the menu. If that is what you meant by online, then so was mine.
Now for the server I also had a simple GUI with a button on it, but I also had a Help menu for the another html document. However, if your server is just start it up, and that's it and that is in your readme.txt, then I don't see the need for another "User Documentation" for your server. Just how to stop it.
Mark
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic