Re: Help - my consultants cannot write!

Subject: Re: Help - my consultants cannot write!
From: "Peter Neilson" <neilson -at- windstream -dot- net>
To: "Andrew Plato" <andrew -dot- plato -at- gmail -dot- com>
Date: Fri, 07 Oct 2011 09:54:35 -0400

On Thu, 06 Oct 2011 17:44:59 -0400, Andrew Plato <andrew -dot- plato -at- gmail -dot- com> wrote:

I am in desperate need of tech writer training for my consultants. I
have a bunch of information security consultants who cannot write.

Andrew Warren suggested:

Wouldn't it be easier to just hire tech writers and teach them to do security consulting?

Ehhhhh, no.

It is unlikely a tech writer would have the engineering and security
background necessary to do security consulting.

A standard method for learning writing or computer programming, one that goes totally against the grain of people who are good at cutting and pasting, is copying and rewriting. If you can somehow get your consultants to spend time following Ben Franklin's method of learning, or the method for learning programming specified in
http://learnpythonthehardway.org/book/ex5.html
then there is a chance for success. Writing is best learned by rewriting. You take something already written and totally rewrite it yourself in your own words.

When I started serious tech writing I did not have any good software available for managing text. Instead I had the IBM Selectric typewriter. It was my friend, because rewriting my paragraphs involved retyping everything. My inherent laziness caused me to want to do less typing, so I took to omitting needless words. (You'll recognize that as Will Strunk's Rule 13.)

Ben Franklin's education in school ended when he was ten. He took to a method in which he would read a chapter of a book, close the book, and write out his version of the material in the chapter. He soon found that he was writing more clearly than the original authors.

It is likely that anyone offered this technique will rebel against it as ridiculous and a waste of time, especially the idea that the material should be written out in longhand or even on a typewriter.

But there is my suggestion. Use or ignore as you please.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.
http://www.doctohelp.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-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

References:
Help - my consultants cannot write!: From: Andrew Plato
RE: Help - my consultants cannot write!: From: Andrew Warren
Re: Help - my consultants cannot write!: From: Andrew Plato

Previous by Author: Re: introducing steps
Next by Author: Re: Anyone can write - just ask the pros
Previous by Thread: RE: Help - my consultants cannot write!
Next by Thread: Re: Help - my consultants cannot write!


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


Sponsored Ads