 | | Suite101 15 found. |
#10877
Advice about Technical Writing
Technical writing doesn't always mean 'computers.' Many companies hire technical writers to document policies and procedures for auditors. This means you would actually sit with someone and write down the steps they follow to do a function. Technical writers must be excellent communicators. Verbal and written skills must be of the highest caliber. A technical writer must be methodical, organized, and succinct.
Taylor, Vicki M. Suite101 (2001). Careers>Advice>Writing>Technical Writing
#18150
Beginning a Documentation Project
Starting a documentation project is like opening a box filled with puzzle pieces and trying to figure out if you have all the right pieces for the right picture without knowing how many pieces make up the puzzle and what the picture looks like.
#18151
We’re inundated with terminology indicating leanness: light, low fat, fat free. Most of the time, you would associate terms like this with food. In this case, I’m associating them with writing -- technical writing to be exact. As a technical writer, your job is to use words to show, describe, instruct, define, persuade, or inform. Your goal should be to communicate only useful information clearly.
Taylor, Vicki M. Suite101 (2000). Articles>Writing
#10876
How to Work as an Off-Site Technical Writer
Not all technical writers get in their car and drive to work every day. Some only work in the office a couple of days a week. Others don’t ever go into the company they work for. These technical writers work entirely from a home office, or in other words, 'off-site.' I’m one of those writers. However, I wasn’t always an off-site writer. For the most part, companies are still reluctant to let employees telecommute. Nevertheless, as more positions are outsourced, consulting is becoming the 'in' position.
#19657
#19617
Introduction to Writing Software Documentation
Documentation is a vital but often unappreciated part of almost every software product. Most software documentation is written by technical writers, employees who specialize in the field. People not in the field often fail to appreciate just how complex the process of writing documentation really is and how dependent it is on developers and other software professionals. There's also a lot of confusion out there about just what technical writing encompasses.
Karin, Janice. Suite101. Articles>Documentation>Writing>Technical Writing
#20706
Publishing Documentation in Microsoft Word: Don't Do It!
To save costs, many small businesses take the do-it-yourself route to publishing product and support documentation. The tool of choice is often Microsoft Word - after all, you probably already have a copy of it and know how to use it reasonably well. But while using Word to develop your materials is an acceptable choice, using it to publish documentation is not! Read on to learn some of Word's shortcomings as a publishing method, and what alternatives are available.
Rosteck, Tanja S. Suite101 (2001). Articles>Documentation>Software>Microsoft Word
#18244
Technical writers are made up of complex individual personae. As a writer, you are expected to have knowledge of your subject. The more subjects you write about, the more knowledge you gain. (Supposedly.) Not every writer is like that, but most are, and they deserve to be congratulated for going the extra mile and actually learning a product they are going to write about. Most writers maintain knowledge about many systems and subjects, thus becoming an 'expert' in the technical writing field.
Taylor, Vicki M. Suite101 (2001). Careers>Advice>Professionalism
#20708
Did you ever see the movie RoboCop? Do you remember the prime directives of RoboCop? As a technical writer, you have prime directives as well.
Taylor, Vicki M. Suite101 (2001). Articles>Writing>Technical Writing
#10875
Software Documentation and Software Processes
One of the more difficult tasks for all Technical Writers is the design and development of software documentation; however, technical writing for the software industry is no longer just writing documentation. To be successful, the Technical Writer must be able to adjust quickly to a fast-paced environment.
#20707
Style Guides and Technical Writing
A style guide consists of formats used when creating documentation. Some companies maintain a formal style guide and adhere to strict documentation standards. Other companies may be more informal, but still maintain some semblance of a style guide, even if it is only an example of the documentation they create.
Taylor, Vicki M. Suite101 (2001). Articles>Documentation>Style Guides
#22625
A medium for all technical writers to add their tips and ideas for becoming a successful technical writer.
Taylor, Vicki M. Suite101 (2001). Resources>Directories>Writing>Technical Writing
#10874
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.
#10873
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
#24122
A place for writers to post questions, to find information, or to encourage others in their writing struggles.
| Copyright © 2001-08 by the EServer. All rights reserved. | Add a Work | Site Preferences | Discussion Forum | Habitués |
