TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
The essential software documentation requirements are universal (i.e., they are technology independent). I am currently providing rigorous (i.e, having gone through a half dozen or more review cycles) software documentation of web middle-tier software. The approach I use is the essentially the same as I have also used for mainframe systems, web application software, packaged softwared, and PLC based software.
Generic Richard
Fred Ridder <docudoc -at- hotmail -dot- com> wrote:
wawelsmok -at- o2 -dot- pl asked:
> Can anyone direct me to some well done, unique examples of software
> documentation? Something outside of the run-of-the-mill PDF guides
> and CHM Helps. Maybe tutorials, well designed UI, etc.
"Software documentation" is such a broad category that I don't think
any of us can be sure what you are seeking. The documentation
requirements are completely different for a mass audience desktop
software application (e.g. a word processor) compared to a web
application (e.g. a picture sharing application), or game software,
or a complex and fairly specialized application (e.g. a sophisticated
photo editing tool like Photoshop), or software for developers
(e.g. APIs or programming languages), or tools for system administrators.
One software application that used to be singled out for special
mention of its documentation was Intuit's Quicken, but I haven't
used that tool for a number of years and don't know whether the
documentation is still as special as it once seemed.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
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 tech44writer -at- yahoo -dot- com -dot-
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.
---------------------------------
Take the Internet to Go: Yahoo!Go puts the Internet in your pocket: mail, news, photos & more.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
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-
