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.
Re: Looking for examples of well-written assembly procedures
Subject:Re: Looking for examples of well-written assembly procedures From:Laura Lemay <lemay -at- lauralemay -dot- com> To:"Janoff, Steven" <Steven -dot- Janoff -at- ga -dot- com> Date:Mon, 27 May 2013 13:33:57 -0700
Look to car repair manuals, Chilton, Haynes, etc. You might be able to find some examples online.
John Muir's How to Keep Your Volkswagen Alive is a classic of the genre (and of technical writing in general), although it is quite wordy by today's standards.
Laura
On May 22, 2013, at 6:44 PM, Janoff, Steven wrote:
> Hi All,
>
> Currently working on a document that provides step-by-step procedures for shop techs on how to assemble a large, fairly complex piece of electro-mechanical equipment.
>
> I'm wondering if anyone has come across any publicly available procedures like this that they find to be exceptionally well written, clear, simple, etc.
>
> Two-person carry, if that helps with dimensions (I'm hedging with details).
>
> The typical step in this procedure begins with words such as "Install," "Attach," "Secure," "Mount," "Fasten," etc., etc.
>
> Hardware is involved -- this is what you'd expect to give the guys on the shop floor and have them come out with an assembled unit.
>
> I have in-house examples to use as models, but I want to get a broader perspective, see if I can glean anything from other work that might be helpful or insightful.
>
> Thank you very much for any help you can give on this one! (It's not essential, just a nice-to-have.)
>
> Steve
>
> PS - I'll do some searching on Google in the interim. Just thought you guys might have some "faves" that you've come across in your career.
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> From our sponsor Doc-to-Help: Want to see a Doc-To-Help web-based Help sample with DISQUS for user commenting?
>
> Learn more: http://bit.ly/13xpg5n
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as lemay -at- lauralemay -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 info.
>
> 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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>From our sponsor Doc-to-Help: Want to see a Doc-To-Help web-based Help sample with DISQUS for user commenting?
