Win a copy of 97 Things Every Java Programmer Should Know this week in the Java in General 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
  • Paul Clapham
  • Jeanne Boyarsky
  • Junilu Lacar
  • Henry Wong
Sheriffs:
  • Ron McLeod
  • Devaka Cooray
  • Tim Cooke
Saloon Keepers:
  • Tim Moores
  • Stephan van Hulst
  • Frits Walraven
  • Tim Holloway
  • Carey Brown
Bartenders:
  • Piet Souris
  • salvin francis
  • fred rosenberger

User documentation

 
Ranch Hand
Posts: 160
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi everybody,

I quote from my specifications :


You must provide basic user documentation. This should be sufficient to allow a user who is familiar with the broad purpose of the project to use the application.
This documentation must be in one of these three formats:
* HTML
* Plain text (not a wordprocessor format)
* Within the application as a help system.



What is the catch here ? Do you think that I lose points if I deliver the user documentation only as HTML ?

Thanks,
Liviu
 
Bartender
Posts: 2292
3
Eclipse IDE Spring Java
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Howdy, Liviu!

Do you think that I lose points if I deliver the user documentation only as HTML ?



No. You have to choose one of the 3 ways to provide instructions to your users. This is the user guide, so if you provide instructions about how to use the application you developed, it should be ok. I chose to create only a plain text user guide, but the main point is to provide instructions about how to use your application in this document.
 
Liviu Carausu
Ranch Hand
Posts: 160
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator

Roberto Perillo wrote:
No. You have to choose one of the 3 ways to provide instructions to your users. This is the user guide, so if you provide instructions about how to use the application you developed, it should be ok. I chose to create only a plain text user guide, but the main point is to provide instructions about how to use your application in this document.



Hi Bob,
Thank you very much for your answer. I can spare some time by not making the help system.
Liviu.
 
There's a hole in the bucket, dear Liza, dear Liza, a hole in the bucket, dear liza, a tiny ad:
Devious Experiments for a Truly Passive Greenhouse!
https://www.kickstarter.com/projects/paulwheaton/greenhouse-1
    Bookmark Topic Watch Topic
  • New Topic