Re: What Program Do You Use For Software Documentation? + Wiki Question

Subject: Re: What Program Do You Use For Software Documentation? + Wiki Question
From: "Paul Weir" <Pweir -at- bju -dot- edu>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 24 Oct 2008 09:21:17 -0400

Thank you all very much for letting me know what program(s) you use for documentation. It seems like Word might suit my needs for now. I was pretty excited about potentially having a reason to learn and use XML, though!

Some of you have asked for more specific details regarding my documentation. Sorry for not including this at the beginning. Here is the info:

I am writing a user guide for an in-house-written database front-end application. InfoMan (Information Manager) is its name and people here use it to record and modify information for all the people, groups and events associated with the University.

My documentation will be used by another IT worker here who will be given the responsibility of answering end-users' questions regarding this program. He will directly use my documentation as a guide, and the end-users themselves also might receive my documentation directly.

Since I will be sort of collaborating with this other IT worker, my supervisor suggested I look into using our companies wiki as well as Word for this project. I noticed a lot of people mentioned the software programs they use (which is what I asked for, so thank you very much!), but I didn't see anyone mention that they use wiki. Is this a technology that is typically not used in the technical writing field? If anyone has a wiki experience with their technical writing, would you care to share your wiki experience?

Sincerely,
Paul Weir
Technical Writer
Bob Jones University
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals.
http://www.doctohelp.com

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

Previous by Author: What Program Do You Use for Software Documentation?
Next by Author: Re: How to I get into this field?
Previous by Thread: Ironic Typo of the Week
Next by Thread: Re: What Program Do You Use For Software Documentation? + Wiki Question


What this post helpful? Share it with friends and colleagues:


Sponsored Ads