Technical writing, a form of technical communication, is a style of writing used in fields as diverse as computer hardware and software,engineering, chemistry,

the aerospace industry, robotics, finance, consumer electronics, and biotechnology. Technical writers explain technology and related ideas to technical and nontechnical audiences. This could mean, for example, telling a programmer how to use a software library or telling a consumer how to operate a television remote control. Technical writers begin by forming a clear understanding of the purpose of the document they will create. If payment for production comes from a second party, this includes a detailed interview with the party that pays for the document's production. Technical writers then typically go on to gather information from existing documentation and from subject matter experts. A subject matter expert (SME) is any expert on the topic that the writer is working on. Technical writers are often not SMEs themselves (unless they are writing about creating good technical documentation). Workers at many levels, and in many different fields, have a role in producing technical communications. A good technical writer needs strong language and teaching skills and must understand the many conventions of modern technical communications. Technical writing teams or departments are often referred to as Information Development, User Assistance, Technical Documentation, orTechnical Publications. Technical writers themselves may be called API Writers, information developers, documentation specialists,documentation engineers, or technical content developers. Advanced technical writers often move into specialized areas such as API writing, information architecture or document management.

Principles: Content Five basic questions - who, why, what, how and when - are applied in various situations to develop the content for any kind of a document. For instance, imagine a situation where you have to create a report based on your balance sheet. Before creating a report, you can plan the content of your report by applying following key questions to the situation: o Who would like to read the report? o Why do you want to/or need to present a report? o What this report is going to present to the audience? o How is the report going to be presented? o When is the report going to be presented? The writing situation: Audience and Purpose

Before beginning any writing task, the writer analyzes audience and identifies the purpose for the document. The writer asks following questions about the audience: o Who will read the document? o What are their biases? o What are technical writer's ethical responsibilities when communicating this to audience? With regard to purpose, technical writers ask: what should this document accomplish? What should it do? Should it: o Inform o Request o Instruct o Suggest o Order o Report o Reply o Analyse/Critique o Compare Organization Writers use an organizational pattern so that it gives consistency to writing. Organizational pattern provide the document with continuity so that audience can comprehend the ideas. For example, writers can organize their ideas chronologically, spatially and categorically. Style Writers change their style depending on the audience. A person would not write an e-mail to a close friend in the same style as a formal memorandum to a manager. Writers adopt either formal or informal styles, depending on the writing situation.

 Accessibility and Specificity Accessibility refers to the ease at which the audience can gain the information they need from a document. Table of contents, headers, footers, page numbers, headings and sub headings help make the document more accessible for the intended audiences. Conventional Grammar and Mechanics Writers adhere to the rules of conventional grammar and mechanics. Technical writers essentially proofread and edit the document for detecting and correcting errors in graphics, typography and layout. Features 1. Title Page The title page will vary according to the style required by the assessor or your company. At a minimum, the title page should include: Name of the university Name of school e.g. School of Mining Engineering Name and code of the subject e.g. MINE1740 Mining Legislation Title of the report Name of author or authors Date of submission Some schools publish styles guides that you are expected to follow when submitting a report. Check with your school office as to whether your school has one. 2. Chapter Numbering System The numbering of chapters and subheadings is normally undertaken throughout the report. The Introduction is generally numbered 1 with the Reference section having the last number. Third level headings are the generally accepted limit (e.g. 8.4.3); too many levels becomes confusing. The preliminary sections (i.e. Table of Contents) prior to the Introduction are not numbered. Appendices should have a heading such as: Appendix A. APL Program for Analysing LANDSAT Data 3. Figures and Tables Figures include diagrams, graphs, sketches, photographs and maps. Tables represent data in columns. All figures and

tables should be numbered and labelled. This caption is placed above a table and below a figure. Each should have a very simple, descriptive caption explaining the figure or table. Any symbols or abbreviations used in the figure or table must be explained in the text. The figure must also be referred to in the text, identified by its number (e.g. Figure 4 shows pore pressure ... ). Avoid using the figure above or the figure below, as text locations may change when editing your report. All figures and tables must be referenced if copied or adapted from another source. 4. Equations and For mulae Equations should be numbered as they appear in the text, with a number in brackets on the right hand side margin. This number is used for identification throughout the rest of the text. Equations are generally centred, with consecutive equations on separate lines and with the equal sign (=) vertically aligned, eg: y = mx + b (1) X =l(h + f) (2) 5. Font Fonts that are easy to read are generally chosen for a report. Times New Roman, Arial and Helvetica are the most popular. Font size should be a minimum of 12 point for the body text, larger sizes are used for the headings with first level headings being the largest. The same font should be used throughout the report. It is important not to distract the reader from the contents of the report. Most word processing programs have report templates in them which can be used as a basis for your report style. 6. Appendices Appendices are supplements to a report. They are included as separate sections, usually labelled Appendix A, Appendix B etc., at the back of the report. An appendix includes: a) information that is incidental to the report; b) raw data and additional evidence which supports the report; c) technical data or specifications which are too long and or detailed but which supports the report; d) Maps, folded diagrams, tables of results, letters are other examples.