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: been asked for advice by "non-writers"? From:Gene Kim-Eng <techwr -at- genek -dot- com> To:Sarah Blake <Sarah -dot- Blake -at- nice -dot- com> Date:Tue, 6 Nov 2012 09:42:32 -0800
The solution to this, provided you have the support of your management, is
to have an announcement made from the top down that the publications group
(or the tech writer if it's just you) will establish corporate style guides
for all manuals. When SMEs follow one of yours and their managers don't
like it, they can fall back on "it's the corporate format," and when the
managers come to you with their contrary preferences you can explain that
doing it the way they want will cause their product's documents to be
inconsistent with the rest of the company's other products. Managers hate
inconsistency, and the higher up the corporate ladder they climb, the more
they hate it.
Gene Kim-Eng
On Tue, Nov 6, 2012 at 8:57 AM, Sarah Blake <Sarah -dot- Blake -at- nice -dot- com> wrote:
>
> I reviewed the latest draft of the document, sat down with her to discuss
> technical writing best practices and the reasons behind them, and...
> discovered that that was the way she'd written her initial draft, and that
> her bosses had insisted on changes that made the document less clear and
> worse structured.
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Writer Tip: Create 10 different outputs with Doc-To-Help -- including Mobile and EPUB.