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.
On Thu, Jan 5, 2017 at 10:36 AM, Paul Hanson <twer_lists_all -at- hotmail -dot- com>
> During my brief stay at a medical device company, yes, there was a
> rigorous QA prior to the user guide(s) I worked on. To follow the "style"
> was to write sentences like this:
> To create a new widget, click *File > New...*.
> The references to the UI were to be bold and verbatim, even though â means
> "a new window opens" when used in a software menu and â in writing means
> what it means.
> When I got the existing user guide, I edited the above original sentence
> to this:
> To create a new widget, click *File > New*.
> During peer review, my co-worker (and senior bitch in the department) told
> me to put the *â* back in.
> The reason I put style in quotations is that when I asked her if the
> standard was to use 1 or 2 spaces after a period (because I had seen both),
> her answer was, "Use 1 unless it looks funny - then use 2."
> *IF IT LOOKS FUNNY?!?*
> And since you mentioned ID, she didn't know how to use styles to create a
> TOC in a an ID file. She manually typed the TOC, including the leader dots
> and the page number, and then printed the entire 150ish page manual to
> manually compare the page number in the TOC to the actual page in the
> document body. If there was a discrepancy, she made the edit and then
> printed the entire document again. She actually bragged about how she had
> been at work until the early AM hours just to get the user manual done by
> deadline. While I commend her for doing whatever was necessary, her process
> was idiotic and so was she because when I showed her a short sample
> document I had created with styles to auto-generate the TOC, she dismissed
> it as being "too complicated."
> Working there was the absolute worst 5 months, 3 weeks, 5 days, in a row
> of the 17199 days I've been on this planet!
> Hang in thereâ
> Paul Hanson
> My blog: *http://prhmusic.blogspot.com* <http://prhmusic.blogspot.com>
> Me Playing Drums:
> Twitter: @prhmusic
> -----Original Message-----
> From: techwr-l-bounces+twer_lists_all=hotmail -dot- com -at- lists -dot- techwr-l -dot- com [
>mailto:techwr-l-bounces+twer_lists_all=hotmail -dot- com -at- lists -dot- techwr-l -dot- com
> <techwr-l-bounces+twer_lists_all=hotmail -dot- com -at- lists -dot- techwr-l -dot- com>] On
> Behalf Of Chris Morton
> Sent: Wednesday, January 04, 2017 11:33 AM
> Subject: Medical device IFU â QA?
> In the medical device realm, shouldn't a device's IFU undergo QA prior to
> release, just as the physical hardware/software undergoes that sort of
> Chris Morton
> â Substantive Editing â Technical Writing â Proofreading
> â Marketing Expertise â Mentoring Click to <
> Visit TechWhirl for the latest on content technology, content strategy and
> content development | http://techwhirl.com
> You are currently subscribed to TECHWR-L as twer_lists_all -at- hotmail -dot- com -dot-
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwhirl.com/email-discussion-groups/ for more resources and
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
> Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com