RE: "How to Write a User Manual"

Subject: RE: "How to Write a User Manual"
From: "Wright, Lynne" <Lynne -dot- Wright -at- Kronos -dot- com>
To: "Cardimon, Craig" <ccardimon -at- M-S-G -dot- com>, "'TechWhirl (techwr-l -at- lists -dot- techwr-l -dot- com)'" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 8 May 2018 18:33:02 +0000

Its a basic overview, for people totally unfamiliar to tech writing, and is fine for what it is...

Except this concept of a documentation plan is odd to me. When I started my first job as a tech writer, I was told to start with a documentation plan; but after a bit of head-scratching I abandoned it, because it was a chicken-an-egg situation: there was no way I could plan out an entire document up front, without knowing anything about the app I was going to write about.

So in effect, my doc plan would have included the target audience, a scope of "describe every feature in the product", and a timeline of "have it done in time for the release of the software, which at this point, is only vaguely projected to be 'sometime in December/maybe january'". So... not useful in any way.

The structure of the information was built/evolved as I worked through researching and documenting each feature. Developing a detailed "plan" to do that would have been a waste of time.

-----Original Message-----
From: techwr-l-bounces+lynne -dot- wright=kronos -dot- com -at- lists -dot- techwr-l -dot- com <techwr-l-bounces+lynne -dot- wright=kronos -dot- com -at- lists -dot- techwr-l -dot- com> On Behalf Of Cardimon, Craig
Sent: Tuesday, May 8, 2018 9:17 AM
To: 'TechWhirl (techwr-l -at- lists -dot- techwr-l -dot- com)' <techwr-l -at- lists -dot- techwr-l -dot- com>
Subject: "How to Write a User Manual"

Greetings,

What are your thoughts on this article:

https://clickhelp.co/clickhelp-technical-writing-blog/how-to-write-a-user-manual/

Cordially,
Craig Cardimon | Senior Technical Writer




Information contained in this e-mail transmission is privileged and confidential. If you are not the intended recipient of this email, do not read, distribute or reproduce this transmission (including any attachments). If you have received this e-mail in error, please immediately notify the sender by telephone or email reply.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as Lynne -dot- Wright -at- kronos -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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -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


Follow-Ups:

References:
"How to Write a User Manual": From: Cardimon, Craig

Previous by Author: RE: Job title for tech writer who does QA testing
Next by Author: RE: Space bar -or- Spacebar
Previous by Thread: Re: "How to Write a User Manual"
Next by Thread: Re: "How to Write a User Manual"


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads