Technical Writing for the Terrified

Introduction

Sometimes it can be a company or person to hire his budget a professional writer to document their technical address. Although in an ideal world, all technical documentation produced by a trained expert will be high, unfortunately, we do not live in an ideal. In the same way that many people try to repair their home, many people try, tracers to high-quality technical documents. Just like aToaster can shock, in an attempt to re-write technical documents, without prior notice, ultimately to failure. As a rule of thumb you should always try to hire a specialist, but if for some reason and you're the poor man, the documentation of the duties imposed on them was despair, not. This short guide describes some of the basic skills you need to bring your writing conventions, technicalaware of things, the software packages that will be considered and may be defined to avoid. We hope that even if you have your life has never written a sentence in anything vaguely technical brings at least a more complete picture of what technical writing.

What is the technique of writing?

Technical Writing, surprisingly, refers to writing that is technical in nature. Although this deceptive act like aDefinition is to remember an important point. Too many technical writers make the mistake of creating documentation that "either too technical or too" literary. A technical writer should be well able to balance between the two of them to meet the end-user documentation. Font technology is a bit "as the fresh air, comfortable and yet virtually invisible. In the networked world in which we are weird, writing techniqueeverywhere. Software manuals, guidelines for home appliances, educational brochures, e-mails, letters, reports, technical reports, statistics and biographies of sports television user examples of technical writing, the people are exposed to basis on a daily basis. If you have tried ever home program the settings of the time on a video recorder and threw his hand across the room in disgust, threw a piece of technical writing (even ifobviously not very good!).

All too often, technical documentation writing produced by writers without a handle big enough piece of technology or technicians who have the ability. As a prospective author of a technical problem you should follow the line of s very sensitive technical knowledge in specialized area (), and a good "writer" (as something against "bad" writers, who usually is in or robbery sweet old ladies.) technical Documentation is usually generated for two different groups of users, ie users of the level of experts and naive users. As a technical writer in your first task is to understand what you sent to the public, the letter leads me to:

Know your enemy

As the old clich?, all the critics. This is especially true for healthy people, techniques to respond before writing. As has been shown the video recorder in the above example,Technical editors can impenetrable to the end user. If this is the case, because whoever wrote the documentation, do not bother to find their audience and write at their level. It seems to me to make it obvious, but that is often overlooked that the user you are creating documents, can it really be an expert. Obviously, if a document specialize in a particular product for a particular group of experienced users (a good example would be to checkSoftware for system administrators of the computer), then you need to compose this is a very different way than if you are creating, for example, a technical manual for the mass market software provides user-friendly house of the novice. One of the first tasks that you perform before you even put on paper have the fingers to keyboard is to determine who you are and your document documents to build on this specific target (s). If this stage rightDocuments should be thrown into difficulties in areas to be avoided!

Planning for Perfection

Once you have identified your target market for the documents you create with it, you have to start planning how documents are organized. This process depends greatly what the documents were submitted, but you can follow some rule of thumb. First, if the documents in support of the very detailed (eg, a PC application) to your dirtyHands on them as quickly as possible. By examining the product in detail, we can formulate a plan of attack and start to compose an organizational structure. While the product is to explore in detail, take notes, how to do this during the first exploratory phase will save time, which is absolutely essential if you are on deadline. Also in the planning phase should ensure that there is a consistency of layout and organizational structure for the document. Select the numberConventions, paragraph styles, ideas and guidelines for the layout now and save time later life.

Have a project

Before you dive head first to create documentation, a project outside of each section first. This is clear if the documents you create do not have a logical "flow" without serious impact on the project. Many technical documents (especially for products, details) are numerous, arising from (and sometimes endless)Iterations. This is because the product moves and changes over time and one of the most important tasks of a technical writer is to keep pace with these changes, and ensure that they are all well documented. Good technical writers always push their projects through many documents as possible, each project will be refined until we reach a situation reflection, in which they (and their employers) is satisfied that the documentation of the timely, accurate, and applies toProduct or process documents.

The devil is in the details

As already noted, technical writing is so named because it is technical in nature. Part of the task for the technical accuracy and precision of a part of it is as detailed as possible. While documents are being created for a group of experienced users and technologically sophisticated, they have to focus on the details of a process, or use a product. This canto make a difficult task, but not if you write for the public. Go to never assume that the reader knows nothing about the product or process is documented, but in the case of advanced / experienced users to recognize at least the good sense to declare probably do not need, such as the appliance, where they at have to operate daily. In describing how to perform a particular activity or activities included in each phase involved (number, if that fits the conventions ofKind of document that you create) and to ensure the accuracy of what you've written it out himself, or better, the rope in a volunteer, the same ranking as the end user.

Choose the right tool for the job

Although you could include technical documentation and blood with parchment is not advisable. Many of the existing specialized software applications, the documentation you create powerful, and part of your duties as a technical writer, the 'right tool for the job. In large part this depends on the type of documents are generated and how they spread. If the documents can be delivered over the Internet, this is certainly a possibility to consider. To this end, use programs like Flash and Dreamweaver MX, to achieve this goal. For the integrated online help, you can create HTML documents raw, or select a specific package, such as RoboHelp or similar. In the case of the pressure onDocuments, you need to handle a software package strong enough, what you throw at it.

Many authors inexperienced technicians immediately turned to Microsoft Word (as it is ubiquitous business community in May and private). If the documents are under 150 pages, and you know how to create models and macros avoid MS Word. Like any technical writer will tell you that all the bad habits and its own can often unstablePackage to work with. If you want to create the graphical documentation heavy, you can consider Quark Xpress or select a potential leader in the field, Adobe FrameMaker. Whatever software you select, make sure to be incredibly skillful, be it through investment in training or assistance day by day!

Communication ? this is what you paid for them to do!

Many people will tell you that the creation of technical documentation is tedious andrepetitive. These people are wrong, and probably idiots. Even if you have documentation "for the process of creating" boring technical (if you're in the wrong job!) It is not. Creation of documents of the technical quality is more important step in the people a simple and correct application of the technology. Although no one approach the documentation that is created in the same way that a new approach that may ultimately help them achieve what they want to achieve withTechnology. No matter how "boring" can be the process, allowing users to their goals by reading the documents should reach to offer a wave of pride and even happiness. As long as you remember the positive impact of technology on the lives of people when you create documents, you can communicate better, how to be happier have in communication. Throughout the life cycle of documentation, you should try to maintain contact with colleagues as often as possible(If applicable). I read the newspapers, listen to their criticism and editing of documents (if you can not argue your corner!). A technical writer is paid to communicate, make sure you do, and never forget why you are communicating and to whom, in these documents.

Common mistakes to avoid

During the preparation of technical documents, a number of serious deficiencies can be done. Although not complete, this section contains somethe most common mistakes new authors make, in the hope of avoiding the help that they will be good:

Be patronizing ? Although the technical documentation should be clear, should never condescending. You are not creating documents to be read by idiots, but consumers and customers. You should always write people, to the skill level of, but no matter what technical people are not stupid. Children are also injured when visited, would not make that mistake withsomeone who is paying his salary, child or others.

Abuse of humor ? people do not read technical documents have fun reading them, the hope of successful completion of a study, or to extract information. If it is relevant to the user, if possible, avoid humor. If you write a book, well and good. If you write a guide, avoid humor like the plague, most cases the user does not miss as in the joke and at the endI hate the condescending idiot who wrote the documentation.

Inconsistency ? When planning, make sure that all the terms used in the document consistent. This is it for the "tone" of the document in relation to the layout. Be sure to use the senses consistent (first-person, etc.) and the page layout elements of the layout, headers and footers, and other text elements.

Proof read ? end up creating a technicalDocumentation, you probably ill considered. It does not matter. What matters is what leaves your office or at home, to be exact. To this end, the document to the test in any draft that is read before it is distributed and read again and again and again. (Never work) never to spell check and when to leave to avoid it, never rely solely on your opinion. Get the document read by so many pairs of eyes as possible before deployment, after all, couldPoint the only thing missing in the whole process of creation.

Conclusion / Shameless self-promotion

Technical writing does not matter what you might think a simple job. Requires experience, patience and a very odd mix of skills. Just like any other job, you can learn to do it, but do not use this teaching. A good writer, you have anal or creative, but focused communicativea flexible and experienced. This, as you can imagine, is not an easy task. Although you might think to create technical documentation is easy to create consistent and timely accurate documentation of a high standard of the trade is a very demanding role. Regardless of your budget to provide long term a significant ROI, when you hire a specialist. After all, they can these days, what we try to tear your hair to achieve in a few weeks if not months to do.

Source: http://speaking-technical-writing.chailit.com/technical-writing-for-the-terrified.html

2011 nba mock draft cna jon stewart bill o reilly dvc facebook.login hard rock cafe danielle staub