Beefy Boxes and Bandwidth Generously Provided by pair Networks
Keep It Simple, Stupid
 
PerlMonks  

Re: Re: Introduction to Technical Writing/Documentation

by sparkyichi (Deacon)
on Dec 07, 2001 at 23:07 UTC ( #130279=note: print w/ replies, xml ) Need Help??


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

I think that this advice is very good in most all writing and it is a key to keeping your readers attuned to what you want to impart to them. I hate to write documentation because I always feel like I am talking down to my reader, but I don't want to assume too much of there reader. It could be alleviated by clearly stating whom the reader is that I have in my mind. Thank you for your post Merlyn.

Sparky


Comment on Re: Re: Introduction to Technical Writing/Documentation
Reaped: Re^3: Introduction to Technical Writing/Documentation
by NodeReaper (Curate) on Mar 22, 2010 at 08:32 UTC

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others pondering the Monastery: (9)
As of 2014-07-11 22:00 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    When choosing user names for websites, I prefer to use:








    Results (235 votes), past polls