Weblinks for Writing Procedures

Technical Writing: How To’s, Tutorials, and Directions has excellent information. Though written for software engineers, it can be modified to fit any technical writing. Includes a good list of essential materials including quick-start resources and samples. And it has a good list of questions to ask. The best part of the page is the links, including those written by the author. Writing How-To’s is excellent.

Alternatives to the paragraph gives a list of other ways to present information besides paragraphs. The best part are the examples of the ways to present information, so you know what a matrix or a logic tree is. Weber also gives a numbered presentation of “Structured Writing,” which to me looks like the description of a post.

Apple’s Style Guide is primarily a long glossary with the words you might want to look up. However, they do include other chapters such as “Technical Notation” and “How to Write a Glossary.”

Techniques gives a list of things to do and not do. My favorite is “Write links that don’t have to be followed.” It says to give enough information that the reader knows whether they would be interested in what is at that link. Another good tip is “Link to additional information.” It tells you that this tip works better in a computer document than it does in a paper one. (I hadn’t ever thought of links as footnotes before.)

Step-by-step instructions for giving step-by-step instructions. This is a fairly short resource, but it begins with examples of things that need step-by-step instructions. The first thing on the list confused me. Recipes was another example, and one I had thought of before. One I had not thought of, which I thought was very good, was getting cash from an ATM. The machine tells you what to do each step of the way. It must be clear to a number of readers– anyone who would use the machine.

Links to step-by-step directions of a non-technical nature:
for using technology common to K-12 classroom, such as Internet Explorer, Word, and PowerPoint.
Study Guides, includes topics such as “Time Management” and “Visual Learners”
eHow, the website for how to do almost everything. Includes “How to Conduct a Passover Seder,” “How to Find Christian Singles Online,” and “How to Diagnose ADHD.”
How to Measure Your Feet, with pictures.

This entry was posted in Technical Writing: Dr. Davis. Bookmark the permalink.

31 Responses to Weblinks for Writing Procedures

Leave a Reply

Your email address will not be published. Required fields are marked *