This week's book giveaway is in the Agile and Other Processes forum.
We're giving away four copies of The Little Book of Impediments (e-book only) and have Tom Perry on-line!
See this thread for details.
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

Documentation? user documentation? file that documents major designs?

 
Jim Martin
Ranch Hand
Posts: 80
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
In the handout, sun describes the README.txt in detail. My questions are:
1) what do they want in the user documentation? and what form should it be, that is should it be userDoc.txt or userDoc.doc or what?
2) What for should the design choice document be? for example should it be designChoice.txt or designChoice.doc or what?
 
Andrea Gazzarini
Ranch Hand
Posts: 125
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Ahoo! Since user guide should be exposed to the user "on-line" , I think it can be in html format.
The design considerations MUST be an ascii file (es. txt) because it can be opened with an editor like VI.
Absolutely you can't use the .doc format (MS Word) !! You can't assume they will read your documentation on WIN platform and they'll have the MS Word installed on their machine!
Hope it helps...
 
Jim Martin
Ranch Hand
Posts: 80
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thank you Andrea
 
Mag Hoehme
Ranch Hand
Posts: 194
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Ahoo,
I had a simple HTML file describing the available functions and how to trigger them. This help file was displayed in a separate frame when the help button was pressed.
Hope this helps.
 
fadi mujahid
Greenhorn
Posts: 28
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
How do u specify the file name and path to load it to the JEditorPanel? keep in mind that you do not know the name of the directory that the source file reside in
thanks
 
Mag Hoehme
Ranch Hand
Posts: 194
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Originally posted by fadi mujahid:
keep in mind that you do not know the name of the directory that the source file reside in
thanks

Use a path relative to the current directory.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic