Technical Documentation,Technical Documentation Standards

How to write Hazard Statements I had already explained about the types of Hazard statements in my previous post. Today I am going to explain how to write those statements. There are certain standard rules which many of the industries follow. The basic rules of the Hazard statement is the color codes. The color codes of Warning , Caution and Notice slightly varies from  industries to  industries. The second rule is the position of the Hazard statements in the manual. As we know that these  Hazard statements are mostly used in the instructional manuals (OM, MM & SM). As per the standard, Warning and Caution should be placed before the procedure/steps starts where you feel there is a potential risk is evolve. Notice can be placed any where on the procedure.  Either before or after the procedure. Start a warning or caution with a simple and clear command. Example: DO NOT GET ENGINE OIL ON YOUR SKIN. THIS OIL IS...

WHAT IS HAZARD STATEMENT Before starting the meaning of Hazard statement , let me explain the meaning of Hazard . In a simple word Hazard is a Risk . Both words are often used in interchangeability. A Hazard is source that can cause damage to human, property and objects. Hazard can be classified based on the various uses and industries. Hazard statement describe the types of  Hazard. TYPE OF HAZARDS There are basically three types of Hazards but it can be customized based on the requirements. 1. Warning 2. Caution 2. Notice Indicates a potentially hazardous situation which, if not avoided, could result in death or serious injury to human. Indicates a potentially hazardous situation which, if not avoided, could result in damage of equipment or objects. Notice gives more information about the situation. if not followed, then it will not caused any harm to human or equipment. This is the brief about t...

WHAT IS DESCRIPTION? It is tough to the make a case for the that means of Description as a result of it comes everyplace, after we write something the word (about).  There is no explicit that means for this word.  Today i'm going discuss concerning the outline of a product or object. DESCRIPTION could be a outline, story and objectives of any object, merchandise shock treatment.. Its provides fast overall read of a product like: product name, sort and variant shock treatment.... Long story briefly, it's a canopy page of the book. Many users generally select the book by trying the duvet page! Similar ways that the outline ought to be written such ways in which it ought to produce a control for a user. To write the outline in a good method, we should always follow the foundations as mentioned below. RULERS Keep the descriptive writing as short as attainable (25 words max). Try to vary sentence lengths and constructions to stay the text fascinating...

WHY WE NEED TO FOLLOW THE RULES IN WRITING? If any topic assign to multiple writers and tell them to note down concerning it. i'm positive that they'll write their own means-albeit the meanings square measure same. Any topic will be written in some ways supported the amount of understanding. The result can, we've got one topic in several vogue. There might not be any similarity between the topics written by the various author albeit the meanings square measure same. Sometimes it'll terribly troublesome for the tip user to grasp the important words. particularly UN agency square measure NON verbaliser. To overcome from the on top of station and maintain the consistency within the documents, we must always follow the writing rule. The advantage of this may, {we will|we'll|we square measure going to} notice the similarity in documents albeit those are written by totally different writers. There square measure few basic rules, i'm about to justif...

What is Simplified Technical English (STE)? The main objective of a controlled language is  to create  technical text  straightforward   to grasp . STE standardizes vocabulary  and magnificence ,  about to  improve consistency, eliminate ambiguity and  cut back complexness . It  conjointly  provides objective criteria for  internal control .  STE includes a general  lexicon  and  a collection  of writing rules.  additionally  to  the overall  vocabulary,  firms   will   outline  their own Technical Names (terminology). Why use STE? In today’s business, clear and consistent authoring has become a necessity: English has become a main language  employed in  technical documentation throughout  the globe ,  however   may be   troublesome   to grasp   thanks to  its  several  forms and complexity:  sen...

Writing Rules The basic writing rules are based on the following elements. Words Noun Phrases Verbs Sentences 1. Words You can use words that are technical name . Example: Bolt, Nut, Washer and Seal etc. Use a technical name only as a noun or an adjective, not as verb. Example: Oil Non-STE: Oil the machined surface. STE: Put oil on the machined surface. Do not use different technical names for the same thing. Example: If you decide to call something e.g. “Servo control unit”, call it in all places (including on illustrations). Do not call it “actuator”, for example, somewhere else If you have a choice, use the shortest and simplest name. Example: Non-STE: Pump outlet volute STE: Outlet of the pump. Use technical verbs only as verbs, not as nouns. Example: Non-STE: Give the hole 0.20 inch over-ream STE: Ream the hole 0.20 inch larger than standard. Make your instructions as specific as possible. Exa...

In engineering,  T echnical D ocuments  refers  the documents which have product reelected data and information. Those documents provide information on: product specification, design, manufacturing, quality assurance, product liability, features, functions , service and repair of a technical produc t. Those documents are use by many stake holders from the time of manufacture of a product till it to go the market. Those are also play a vital role in the after market support. There are many different types of documents available for a product. Basically those can be classified by in two categories. 1.  Process Documents 2.  User Documents Process Documents: These documents are used during the product development and manufacture. For example : Technical Data Sheet (TDS) , Product Specification Sheet , Safety Data sheet (SDS) , Engineering Drawings ect. User Documents:  T hese documents are prepared for the end users. User documents includ...