Skip to main content

Will Technical Documentation Ever Rule the World?

Post a Comment

Simplified Technical English - Writing Rules

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.
Example:
Non-STE: Turn the handle clockwise, then vice-versa
STE: Turn the handle first clockwise, then counter clockwise

2. Noun Phrases

Do not make noun clusters of more than three nouns
Example:
Short noun cluster: Runway light connection
Long noun cluster: Runway light connection resistance calibration

Clarify noun clusters that are technical names with one of these two methods:
Use hyphens to show the relationship between the most closely related words.
Explain the noun cluster. Then, if possible, use a shorter name after the initially explanation
Example:
Non STE: Landing light cutoff switch power connection
STE: Landing-light cutoff-switch power connection

Use an article (the, a, an) or a demonstrative adjective (this, these) before a noun
Example:
Non STE: Lift up assembly and put in a box
STE: Lift up the assembly and put it in a box

3. Verbs

Only use those forms of the verb that are listed in the dictionary.
Example: ADJUST, ADJUSTS, ADJUSTED

You must not use the “-ing” forms of the verb.
Use the approved forms of the verb to make only:
The infinitive
The imperative
The simple present tense
The simple past tense
The past participle of an adjective
The future tense

Refer to the below examples for the forms of verbs.

The infinitive: (TO ADJUST or simply ADJUST)
The imperative (“commanding” form) (ADJUST the)
The simple present tense (it ADJUSTS, you, we, they ADJUST)
The simple past tense (it ADJUSTED)
The past participle of an adjective (the ADJUSTED linkage)
The future tense (you will ADJUST)

Use the past participle only as an adjective, either with a noun or after the verbs
Example: DISCONNECTED
Connect the disconnected wires
The wires are disconnected.

 4. Sentences

 Keep to one topic per sentence.
Non-STE: The side stay has two main members and two folding toggles hinged together and attached with the hinges between the main gear strut and the side stay bracket.
STE: The side stay has two main members and two folding toggles. These are attached with the hinges between the main gear strut and the side stay bracket.
   
Do not omit words to make your sentences shorter.
Non-STE: Rotary switch to INPUT.
STE: Set the rotary switch to INPUT.

Use tabular layout (vertical layout) for complex text.
Example:
The controls on the main panel, from top to bottom, are:
‒ An OFF/ON main switch
‒ A START push button
‒ A STOP/O.S. Test push button








Comments

Post a Comment

Popular posts from this blog

Will Technical Documentation Ever Rule the World?

Technical Documentation Now-a-days each company area unit specialising in documentation activity equally because the alternative thought activities before product launch. There are many types of Technical Documents which need to be prepared before the product released. All the document should be prepared with the the current technical writing standards. Question is WHY? Why the organisation is putt equally effort towards product documentation? What made them to do so? The answer is: When company launches any product; they need to train the people on: About the product, How to use it, How to troubleshoot the issues and how the maintain serviceability etc. Now, a question may comes in your mind that, company can provide training session for the users rather than putting the effort in documenting entire product. Then why documentation is necessary? The documents are prepared by Technical Writers . Technical  Writers may be handy to the users forever and that they w...
Post a Comment
Read more

How to Write a Self Appraisal Effectively

How to Write a Self Appraisal Effectively As we all know that it is the time of year again. I am not telling about your summer vacation. I am telling about the annual performance review. As we prepared before holiday travel and attending parties, similar way we need to think and plan before completing the Self Appraisal. Why self-appraisal is so important It is an opportunity for employees to self-reflect and consider what their strengths and weaknesses. You may be under the impression that your manager remembered all the great accomplishments and successes you had throughout the year.  However, it is also your responsibility to bring all your successes to your manger's notice. For managers, self-assessments offer several benefits. They illuminate how the employee sees themselves in the context of the team and the organisation at large. It also highlights any disagreements between the manager and the employee. The self-assessment is an opportunity for fe...
Post a Comment
Read more

How to Solve Problems and Make Right Decisions?

It is common that each and everybody face problems in  our day to day life. Sometimes many of us became  hopeless with out knowing the real cause of the problem.  Due to this  miss-understanding, the existing problem leads to  create  many new problems. Today I am discussing some tips to resolve the problems. Happy Friendship Day Quotes and Essay Define the problem When people found any trouble, they react to what they think the problem is. Instead of to understand more about why you think there's a problem. Define the problem: Ask yourself and others, the following questions: 1.  What can you see that causes you to think there's a problem? 2.  Where is it happening? 3.  How is it happening? 4.  When is it happening? 5.  With whom is it happening? 6.  Why is it happening? 7.  Write down a five-sentence description of the problem what you feel. Write as much as possible and be specif...
Post a Comment
Read more