http://qs1969.pair.com?node_id=130273


in reply to Introduction to Technical Writing/Documentation

A few random notes from my 23+ years of tech writing:

-- Randal L. Schwartz, Perl hacker

  • Comment on Re: Introduction to Technical Writing/Documentation

Replies are listed 'Best First'.
Re: Re: Introduction to Technical Writing/Documentation
by sparkyichi (Deacon) on Dec 07, 2001 at 23:07 UTC
    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