TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: "15 Tips to Improve Your Technical Writing" From:Chris Despopoulos <despopoulos_chriss -at- yahoo -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 16 Oct 2019 11:45:05 +0000 (UTC)
I agree with Peter... Nothing new here.Â
The problem with just about everything written about technical writing is that it's all "How To" documentation. Specific procedures to address specific tasks. Where's the discussion that tells us how to arrive at these 15 tips, or how to evaluate whether they make sense, or how to come up with tip #16?
So far the only approach I've seen that is at a higher level is Jim Carroll's with minimal manuals. That's a theoretical approach to documenting tasks, specifically (as far as I can tell). Oh, and "The Theory and Practice of Technical Writing" by Samuel Chandler Earle actually stands the test of time IMO, even with a date of 1916... He has an awesome concept of a synopsis to criticize and to plan a piece of writing. Aside form that, all I've seen are How-To docs... Task oriented, if you will.Â
I think tech writing suffers for want of a theory. You can guess that I'm working on a book... I wonder if I started up a blog, would that get any attention? It would be nice to try out some of the ideas.
cud
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com