PDA

View Full Version : Documentation Templates and Tips



EnigmaticCoder
May 6th, 2010, 10:28 PM
I plan to write documentation for a program that I've used the past few years, and I have a few questions.

Can you recommend a template?
Do you have advice about writing documentation or about technical writing in general?

red_Marvin
May 6th, 2010, 11:03 PM
Depends on what kind of program it is, and what kind of documentation you are talking about.
E.g. if it is a console program and you want to document how the user would interact with it, you should write a man page. That would need something like troff/groff if I'm not mistaken.
If it is more a report LaTeX might be appropirate.
If it's documentation of user interaction with a gui program; LaTeX or html depending on how you want to publish it.

EnigmaticCoder
May 6th, 2010, 11:07 PM
I should've been more clear. I'm writing documentation for lxdream, so it's "documentation of user interaction with a gui program."

EnigmaticCoder
May 7th, 2010, 03:31 AM
Does anyone who has written documentation want to chime in?