Win a copy of Pipeline as Code this week in the Cloud/Virtualization forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Ron McLeod
  • Paul Clapham
  • Jeanne Boyarsky
  • Bear Bibeault
Sheriffs:
  • Rob Spoor
  • Henry Wong
  • Liutauras Vilda
Saloon Keepers:
  • Tim Moores
  • Carey Brown
  • Stephan van Hulst
  • Tim Holloway
  • Piet Souris
Bartenders:
  • Frits Walraven
  • Himai Minh
  • Jj Roberts

Userguide question.

 
Ranch Hand
Posts: 918
IntelliJ IDE Java Linux
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hi

I am ready with my URLyBird - I start to prepare the deploy and I have a small question about the the documentation.

My GUI provides an online help based on chained HTML files - this files are accessible from the GUI side via the online help system, thats why all this html files are packed in the runme.jar.
According with my specification I need to provide user documentation for the database and server


User documentation for the database server and the gui client. If your user documentation is online then you may omit this file. However, if the documentation is not online, you must provide either a single plain ASCII (not word processor format) text document, which must be called userguide.txt, or multiple HTML files which must all be accessible from a starting point document that must be called userguide.html.



I choose the html version. For this I make a separate copy of the html files form the online help, I provide an userguide.html start page and I chain this to the online help files. But in this way I have the online help two times once in my jar for the online help and once for the userguide, this is a little bit redundant.

What you people think about ?

Regards M
 
Ranch Hand
Posts: 1855
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hi Mihai,

seems somewhat redundant to me .

Originally posted by Mihai Radulescu:
However, if the documentation is not online, you must provide either a single plain ASCII (not word processor format) text document, which must be called userguide.txt, or multiple HTML files which must all be accessible from a starting point document that must be called userguide.html



Regarding your assignment quote one version either online (your help) or as HTML file (userguide.html) should be sufficient.

I used the userguide.txt variant

Regards,
Darya
 
Mihai Radulescu
Ranch Hand
Posts: 918
IntelliJ IDE Java Linux
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hi Darya.

Do you mean, you provide online help and userguide.txt

Regards M.
 
Darya Akbari
Ranch Hand
Posts: 1855
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
I submitted only userguide.txt
 
Greenhorn
Posts: 19
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
My undestanding of this is that you should only provide one item.
That is:
online help system or userguide.txt or userguide.html (+ other html files)

Best regards
 
Mihai Radulescu
Ranch Hand
Posts: 918
IntelliJ IDE Java Linux
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
From my specification :


User documentation for the database server and the gui client. If your user documentation is online then you may omit this file. However, if the documentation is not online, you must provide either a single plain ASCII (not word processor format) text document, which must be called userguide.txt, or multiple HTML files which must all be accessible from a starting point document that must be called userguide.html.



please notice the you may (...then you may omit this file). The only must comes after and regards the missing if the documentation.
I interpret this in this way:
1.you must provide documentation
2.you can provide an online help system or
3.you can choose the plain text file
4.if you provide the online help system you can (this is your choice) omit the point 3 or 4


What you guys think about ?
 
Darya Akbari
Ranch Hand
Posts: 1855
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hi Mihai,

for the redundancy no one can punish you. If you feel safer when you put the extra userguide.html to your submission then go ahead . You only don't get extra points for them.

But take care about the musts. The musts are the one that kills.

I counted 81 musts in my assignment and made a list of them. That helped a lot and I really looked for complying with each must out of my 81 musts.

See this thread: How to cope with assignment's MUST conditions

Good Luck,
Darya
 
Mihai Radulescu
Ranch Hand
Posts: 918
IntelliJ IDE Java Linux
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Thanks for link,
I don't risk so I choose the redundant solution (online help and userguide.html).

Regards M
 
We should throw him a surprise party. It will cheer him up. We can use this tiny ad:
SKIP - a book about connecting industrious people with elderly land owners
https://coderanch.com/t/skip-book
reply
    Bookmark Topic Watch Topic
  • New Topic