Re: Documentation Correctness was Re: How many levels of indents and heads are reasonable?
Subject:Re: Documentation Correctness was Re: How many levels of indents and heads are reasonable? From:"Bill Swallow" <techcommdood -at- gmail -dot- com> To:"stevefjong -at- comcast -dot- net" <stevefjong -at- comcast -dot- net> Date:Wed, 17 Oct 2007 13:16:08 -0400
Thanks Steve, this is a very good example. I'll agree here that not
all writers do this, but I do know many who do (self included). It's
really the only way to ensure your docs are accurate, and I try to
test my docs against a clean install or setup of anything I've
documented to look for holes or redundancy. After all, getting the
task flow right is only one of many steps. It's that final check that
ensures it all came together as intended.
On 10/17/07, stevefjong -at- comcast -dot- net <stevefjong -at- comcast -dot- net> wrote:
> For example, imagine that you are documenting how to set up your product to communicate with an external database.
--
Bill Swallow
HATT List Owner
WWP-Users List Owner
Senior Member STC, TechValley Chapter
STC Single-Sourcing SIG Manager http://techcommdood.blogspot.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-