Beefy Boxes and Bandwidth Generously Provided by pair Networks
"be consistent"
 
PerlMonks  

Re^2: Introduction to Technical Writing/Documentation

by JohnHerald (Initiate)
on Jan 20, 2011 at 17:21 UTC ( #883372=note: print w/ replies, xml ) Need Help??


in reply to Re: Introduction to Technical Writing/Documentation
in thread Introduction to Technical Writing/Documentation

Actually, the phrase was an old saw in radio copywriting, where you repeated things three times. The formula does have its applications in technical writing, but it would take a stretch to make it fit. For one, if we wrote everything three times, our instructions would balloon accordingly. Yes, we should give the reader a clue as to what we're going to tell them, and it's a good idea to give a summary at the end. But how many people have the time or interest to wade through all that?


Comment on Re^2: Introduction to Technical Writing/Documentation
Re^3: Introduction to Technical Writing/Documentation
by Anonymous Monk on Jul 13, 2011 at 01:33 UTC
    In my opinion, the "Three T" only applies to presentations, the so called, sales pitch. Technical documenting is serious and the most important portion of it is research, research, research...
Re^3: Introduction to Technical Writing/Documentation
by Anonymous Monk on Jul 13, 2011 at 09:33 UTC

    "Actually, the phrase was an old saw in radio copywriting, ..." -- JohnHerald. Performance Today is very irritating that way. I wish my radio clock would shut off when non-instrumental audio is encountered during the 2 hour period. ~_#

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://883372]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others making s'mores by the fire in the courtyard of the Monastery: (5)
As of 2014-12-25 22:29 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    Is guessing a good strategy for surviving in the IT business?





    Results (163 votes), past polls