SCJP,SCJD,SCWCD,SCBCD,SCDJWS,SCEA
"I'm not back." - Bill Harding, Twister
Originally posted by Bharat Ruparel:
Things have definitely become less interesting. The dreaded documentation time!
Originally posted by Bharat Ruparel:
Any ideas on how long should the User's Guide (userguide.txt) and choices.txt documents can be? Or a better question should be?
Originally posted by Bharat Ruparel:
Since these are supposed to be plain ASCII text files, can the screen shots be included?
Originally posted by Bharat Ruparel:
Any ideas on how to organize them and write them?
The Sun Certified Java Developer Exam with J2SE 5: paper version from Amazon, PDF from Apress, Online reference: Books 24x7 Personal blog
SCJP,SCJD,SCWCD,SCBCD,SCDJWS,SCEA
The Sun Certified Java Developer Exam with J2SE 5: paper version from Amazon, PDF from Apress, Online reference: Books 24x7 Personal blog
Things have definitely become less interesting. The dreaded documentation time!
A file called choices.txt that containing pure ASCII(not a word processor format) text describing the significant design choices you made. Detail the problems you perceived, the issues surrounding them, your value judgments, and the decisions that you made. This document should also describe any uncertainties you had regarding the project, and the decisions you made while resolving them.
SCJP,SCJD,SCWCD,SCBCD,SCDJWS,SCEA
,But I left documenting my project until the end, by which time I was sick of the whole project. So I didn't enjoy it.
SCJP,SCJD,SCWCD,SCBCD,SCDJWS,SCEA
Any tools that you can recommend for writing HTML documentation? I have Microsoft FrontPage, will that work?
"I'm not back." - Bill Harding, Twister
Andrew:
PS: When writing your choices.txt file, try and avoid the temptation of stating your reason for a design as "Phil doesnt like it"
"I'm not back." - Bill Harding, Twister
Did you see how Paul cut 87% off of his electric heat bill with 82 watts of micro heaters? |