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: Press this, or just Press From:"Mike Starr" <mike -at- writestarr -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Sun, 4 Mar 2007 11:37:51 -0600
And sometimes when the company style guide imposes arbitrary limitations
that were created without anticipating situations like you describe I don't
hesitate to ignore the style guide and create a document that actually
serves the user instead of conforming to a standard that would result in a
crappy and difficult-to-maintain document. But then again, I've never been
afraid to get fired over resisting stupidity.
However, for those less secure in their career, why not take the content and
create an alternative version of a couple pages as a proof-of-concept?
Mike
--
Mike Starr WriteStarr Information Services
Technical Writer - Online Help Developer - Website developer
Graphic Designer - Desktop Publisher - MS Office Expert
Phone: (262) 694-1028 - Tollfree: (877) 892-1028 - Fax:(262) 697-6334
Email: mike -at- writestarr -dot- com - Web: http://www.writestarr.com
----- Original Message -----
> From: "Kathleen MacDowell" <kathleen -at- writefortheuser -dot- com>
> Subject: Re: Press this, or just Press
>
> I didn't send out the original question, I just sent a comment.
>
> Right now I'm writing a user's guide for a universal remote with a touch
> screen and hard buttons. The remote controls up to 10 devices. So it does
> have a GUI, but lots of different screens. Often, both the buttons and
> touch-screen keys are used to accomplish a task. It can be complex.
>
> We don't know that the materials we're producing will be translated, but
> the decision was made to set them up as if they would be. I didn't make
> the
> decision and generally prefer to have the information in the figure. But
> there are trade-offs, such as having an overly busy figure/multiple
> figures. There are alternative approaches that would make layout easier,
> such as inline figures, but the company templates don't allow for that.
> Finally, most of the products in the line I'm working on are fairly small
> (3
> x 5 in.), and the installation materials are in an A5 layout, so the
> figures
> can't have too much content.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-