Tips for Technical Writers

Begin by getting familiar with your corporate style. If there is no existing style guide, either review existing manuals to determine what has been done in the past ( Pay special attention to the language, assumed prior knowledge, general organization and presentation of how-tos (task-based or informational)) or choose a style guide.

Hanvey, Jeff. Suite101. Articles>Style Guides

Tracking Reviewers' Comments

I had a manual under review by over 60 people. I posted a question about how to track all of their comments. Here is the summary. Thanks to everyone who responded. You all gave me a lot to think about. I realized as I got the comments that I left out a crucial piece of information...the manual went out to our managers and maintenance specialists in the field (we have offices all over the United States). Thus, we can't hold traditional meetings.

Hanvey, Jeff. Suite101. Reference>Editing>Groupware>Workflow