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.
I've got a stubborn project manager, and I need help either finding ammo
to shoot her down with, or finding out that I'm wrong-headed about this.
We have a book of procedures, and many of those procedures have a table
inside. And some of those table cells have small embedded procedures.
So we're talking about something like this:
6. Continue with the following:
----------------------------------------------------------
| To... | Do this... |
----------------------------------------------------------
| Some action | Some step |
----------------------------------------------------------
| Some action | 1. Step one |
| | 2. Step two |
| | 3. Step three |
----------------------------------------------------------
| Some action | Some step |
----------------------------------------------------------
7. Next step.
To me, this is common sense. But this project manager is insisting on:
6. Continue with the following:
----------------------------------------------------------
| To... | Do this... |
----------------------------------------------------------
| Some action | Some step |
----------------------------------------------------------
| Some action | 7. Step one |
| | 8. Step two |
| | 9. Step three |
----------------------------------------------------------
| Some action | Some step |
----------------------------------------------------------
10. Next step.
So. Should I let her have her way? Or should I stand my ground on
readability? And if so, are there studies or anything I can show her
besides my insistence?
Thanks for any advice, y'all :)
Christian
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-