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.
Subject:Re: General formatting question for a TOC From:"Julie Stickler" <jstickler -at- gmail -dot- com> To:"Tammy Van Boening" <Tammy -dot- VanBoening -at- healthlanguage -dot- com> Date:Tue, 13 Nov 2007 17:32:53 -0500
> However, an edit that I received recently indicated that the editor's
> (i.e., developer's) preference was to put in only Heading 1 levels
As a general rule, I want developers to give me technical edits and
point out missing information. And that's it. Although they can be
helpful with catching the occasional rogue typo.
Developers are experts on the product, but they usually aren't experts
on writing, grammar, our style guide, usability, technical
documentation, single sourcing, localization, etc. So far I've been
lucky (or have managed to be diplomatic enough when I ignore some of
their "suggestions") and have never had a major problem with a
developer insisting that I make all their changes.
But when I do finally run into that determined developer, I'd probably
start offering my suggestions on how they should write code. ;-)
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-