writing tips
about the writing tips
As we work with our clients and discuss issues with our fellow writers, we encounter a lot of questions about writing. There are many excellent resources available on writing, and this section is by no means a substitute for any of them. It is intended as a supplemental section to address some of the common issues that are raised to us.
Should you have other questions, feel free to contact us and we will post the answer to this section on a periodic basis.
frequently asked questions
Since I am a lone writer, there is nobody here for me to discuss my ideas with. Are there any tips/tricks for this?
Build up your network, both locally and online. The technical writing lists are very supportive and often you will receive multiple responses to the same question. In addition, a number of very talented and respected writers throughout the world contribute to the body of knowledge on these sites (for example, www.techwr-l.com). Furthermore, subscribe to mailing lists in the digest format so you have a good amount of learning material in your email every day.
What are some quick questions to ask when beginning to write?
Some quick questions include: Who is the audience? How much technical information do they need or want? What assumptions or prerequisites need to be included for the user? What tasks do the users need to know? What is the most logical order to present this information? How does the development process of the product—the software deadlines, and so on—affect my writing process? Which documentation processes will I need to ensure an efficient project?
How do I know what users want?
Connect with your users. There are a number of different methods available to do this, including conducting an information audit of your documentation, usabilty studies, and talking directly to your customers. Through these methods and others (search online) you will learn more about your users and whether the current documentation is meeting their needs. In general, users like to read as little as possible, like to scan quickly, and want access to specific information easily. They want to complete tasks in a single workflow rather than needing to jump to other sections of the guide and back again.
Will taking the time to establish documentation standards and processes help me produce content faster and easier?
Yes. We have seen project budgets balloon by over 100% simply because there were no standards or processes in place. You may want to work toward the following: well-designed templates that reduce the time for writing and updating, documentation plans for large projects, checklists for reviewers, well-defined roles and responsibilities, editing targeted at specific goals for the users, consistent terminology and structure for ease of use and updating, usability testing to confirm a good user experience, and information designed specifically for the medium and audience.
about the photo
This photo was taken on the grounds of the Edinburgh castle. The audience is turned in the direction of the tour guide. From the photo angle, however, they appear to be a sea of backs turned away from the photographer. Connecting with users by spending time to identify the actual needs for content and how to meet it yields the tour guide perspective.
© 2003-2008 Writer Types Inc.