Research

PRESENATION IN RESEARCH I MOTHER GROUP 5

Technical Writing presents and explains briefly a subject or a topic in a manner that the readers can understand the thought of the article. It is also a style of writing that is being used in the fields of computer, hardware, engineering and chemistry. TECHNICAL WRITING

CHARACTERISTICS OF TECHNICAL WRITING

Technical Writing uses technical vocabulary. It uses graphs, tables and figures to show the different things related to the topic. CLARITY- The written document must be clear and concise so that the text becomes easier to grasp and understand. Because we all know that writers are aware of doing technical writings they are the one who are well-trained in this field. The writers should be aware of the technical methods that they are using in the document for the reader to understand the article. Descriptiveness- A well-written technical document always contains answers to anticipated problems in the product or application. In this type of characteristics a report or article should have descriptions. MANUALS Descriptiveness. In some cases readers can’t understand directions specially if you only dictated it to them so for them to understand the procedures in assembling the thing they bought we should write the things that they should follow.

ACCURACY- Effective communication requires quality content and language that is accurate and readable. Technical writing does not mean that you translate information unquestioningly. In this profession, one must know for whom the document is being written and whether it is accurate. CORRECTNESS- The grammatical structure of your technical document should be correct and free from any kind of ambiguities. The intended meaning will not be communicated to the reader if the document has ambiguous sentences. A well-organized document that makes use of headings and sub-headings is not only pleasing to the eye but will also helps the reader to find specific information in a short time.

Technical Writing uses a relatively high concentration on certain complex and important writing techniques particularly description of a mechanism, descriptions of processes, classifications, and causes and effects, comparisons and contrasts, analogy and interpretations. It uses the conventional report forms.

PURPOSE AND FUNCTIONS OF TECHNICAL WRITING

1. To inform -It is written to make others understand something. It is designed to fulfill the needs to tell and know. 2. To analyze events and their implications -It will explain how certain systems failed. This system may include education, socioeconomic, political and the needed change. 3. To persuade and influence decisions -It will show how a business or an industry succeeds. And how one does anything or everything for his/her article.

FUNCTIONS To serve as a basis for management decision. To furnish needed information. To give instructions. To explain techniques. To report achievements. To analyze problem areas. To determine design and system requirements. To serve as a basis for public relation. To provide reports to stockholders of companies. To develop a product. To provide service. To record business through proposals. To procure business through proposals.

BASIC PRINCIPLES OF EFFECTIVE TECHNICAL WRITING.

Understanding The reader ,[object Object]

They should understand the readers in a way that they won’t use unfamiliar words in his/her article.If a writer used difficult technical terms in his/her article He/she should define them in a way that the readers can Understand the meaning of the word for them to not do Panicking specially in arranging something.

2. Knowing the purpose of each article or report. The technical paper must be organized around a central theme. The readers should understand and get the main purpose of the article after reading it. For them to know the purpose of the article maybe the purpose is to describe a thing in a scientific way, To report on a specific problem or to analyze and solve a problem. This principle is very important because we all know that in Every article there is a purpose and this principle widens the meaning of knowing the purpose of a report for us to be informed.

3. KNOWING THE SUBJECT MATTER A technical writer must have a thorough knowledge of the subject he is going to write. If the report is based on those experiments they conducted they should explain the results and the problem they are solving. A writer should be aware and informed enough in writing his/her article or they should have knowledge (enough) for them to briefly explain the topic.

4.Writing objectively An author or writer should write objectively so that the readers can understand the meaning and objectives of your article. 5. Using Correct Format A writer should use correct formats for the readers to understand his article. 6. Adopting Ethical Standards

END PRODUCTS OF TECHNICAL WRITING 1. Technical Report - is a document that describes the process, progress, or results of technical or scientific research or the state of a technical or scientific research problem. It might also include recommendations and conclusions of the research. Unlike other scientific literature, such as scientific journals and the proceedings of some academic conferences, technical reports rarely undergo comprehensive independent peer review before publication. Where there is a review process, it is often limited to within the originating organization. There are no formal publishing procedures for such reports, except where established locally.

2. Abstract - is a brief summary of a research article, thesis, review, conference proceeding or any in-depth analysis of a particular subject or discipline, and is often used to help the reader quickly ascertain the paper's purpose. When used, an abstract always appears at the beginning of a manuscript, acting as the point-of-entry for any given scientific paper or patent application. Abstracting and indexing services for various academic disciplines are aimed at compiling a body of literature for that particular subject.

3. Feasibility Report - answers the question of whether a plan should be implemented by stating "yes", "no", and sometimes "maybe". Not only recommendation, Feasibility Report should also provide the data and the reasoning behind that recommendation * Feasibility studies - aim to objectively and rationally uncover the strengths and weaknesses of the existing business or proposed venture, opportunities and threats as presented by the environment, the resources required to carry through, and ultimately the prospects for success.

4. Business Letter - is a letter written in formal language, usually used when writing from one business organization to another, or for correspondence between such organizations and their customers, clients and other external parties. The overall style of letter will depend on the relationship between the parties concerned.

5. Brochure - (also referred to as a pamphlet) is a type of leaflet. Brochure may suggest other points of interest. * The most common types of single-sheet brochures are the bi-fold (a single sheet printed on both sides and folded into halves) and the tri-fold (the same, but folded into thirds). A bi-fold brochure results in four panels (two panels on each side), while a tri-fold results in six panels (three panels on each side).

6. Contract - is a legally enforceable agreement between two or more parties with mutual obligations. The remedy at law for breach of contract is "damages" or monetary compensation. In equity, the remedy can be specific performance of the contract or an injunction. Both remedies award the damaged party the "benefit of the bargain" or expectation damages, which are greater than mere reliance damages, as in promissory estoppel.

7. Instruction Manual/ Owner's Manual - is an instructional book or booklet that is supplied with almost all technologically advanced consumer products such as vehicles, home appliances and computer peripherals.

Information contained in the owner's manual typically includes: Safety instructions; for liability reasons these can be extensive, often including warnings against doing things that no intelligent person would consider doing. Assembly instructions; for products arrive in pieces for easier shipping. Installation instructions; for productions that need to be installed in a home or workplace. Setup instructions; for devices that keep track of time or which maintain user accessible state. Normal usage instructions. Programming instructions; for microprocessor controlled products such as VCRs, programmable calculators, and synthesizers. Maintenance instructions. Troubleshooting instructions; for when the product does not work as expected. Service locations; for when the product requires repair by a factory authorized technician. Regulatory code compliance information; for example with respect to safety or electromagnetic interference. Product technical specifications. Warranty information; sometimes provided as a separate sheet.

8. Proposal Letter - deal with a ‘proposal’, that is, an attempt to inform and persuade the recipient to do something. There are different types of proposal letters – business proposal letters, project proposal letters and others. They may offer to fund a program or project, to purchase or sell products or services, or may just be a way to commit to a course of action. A proposal contains certain important elements that must be mentioned to have a better chance of persuading the reader. These elements should include what the sender proposes to do, how he or she intends to do it, when, and how much it will cost. The following basic points must be kept in mind while writing proposal letters: Do adequate background research on the company and use that information while writing your proposal Define the problem that you intend to solve Suggest ways by which you can help the company and how it will be beneficial to both of you

9. Progress Report - to inform a supervisor, associate, or customer about progress you've made on a project over a certain period of time. The project can be the design, construction, or repair of something, the study or research of a problem or question, or the gathering of information on a technical subject. You write progress reports when it takes well over three or four months to complete a project. In the progress report, you explain any or all of the following: How much of the work is complete What part of the work is currently in progress What work remains to be done What problems or unexpected things, if any, have arisen How the project is going in general

10. Policy - is typically described as a principle or rule to guide decisions and achieve rational outcome(s). The term is not normally used to denote what is actually done, this is normally referred to as either procedure or protocol. Whereas a policy will contain the 'what' and the 'why', procedures or protocols contain the 'what', the 'how', the 'where', and the 'when'. Policies are generally adopted by the Board of or senior governance body within an organization where as procedures or protocols would be developed and adopted by senior executive officers. *A Policy can be considered as a "Statement of Intent" or a "Commitment". For that reason at least, we can be held accountable for our "Policy". *The term may apply to government, private sector organizations and groups, and individuals. Presidential executive orders, corporate privacy policies, and parliamentary rules of order are all examples of policy. Policy differs from rules or law. While law can compel or prohibit behaviors (e.g. a law requiring the payment of taxes on income), policy merely guides actions toward those that are most likely to achieve a desired outcome. *Usually they are well documented users manuals, Support manuals, and technical manuals with diagrams. I hope this helps.

11. Article for a Technical Journal - an article written about a Technical Journal. Technical Journal - someone writes down an instruction (a step) to make the program work. 12. Monograph - forms a component of the review of literature in science and engineering. - a work of writing upon a single subject, usually by a single author. It is often a scholarly essay or learned treatise, and may be released in the manner of a book or journal article. It is by definition a single document that forms a complete text in itself. An author may therefore declare his own work to be a monograph by intent, or a reader or critic might define a given text as a monograph for the purpose of analysis. Normally the term is used for a work intended to be a complete and detailed exposition of a substantial subject at a level more advanced than that of a textbook.

Research

Recommandé

Recommandé

Contenu connexe

Tendances

Tendances (20)

Similaire à Research

Similaire à Research (20)

Dernier

Dernier (20)

Research