Rules in technical writing

She talked about the fundamentals that lay at the core of Technical Writing.

Rules in technical writing

One of the most basic we impose that order on an otherwise unruly collection of information is the application of stringent punctuation rules. When sentences and lists are punctuated in exactly the same manner, sentence after sentence, the mind subconsciously detects an order and submits to the superior logic of organization.

Otherwise it rebels and questions first the credibility of the writer and then the veracity of the content. Such documentation is no good to anyone. Big rule of thumb: Both options are okay but ending one bulleted item with a period and leaving the other open is not acceptable.

Soon the reader starts thinking: In a technical document, every regular sentence should end either in a period or a question mark. Erase that from your tool kit and save it for your opinion pieces or poems. If you are using quotation marks, periods and commas should be placed right inside the second quotation mark.

Most spell- and grammar-checkers will flag double-space as an error. Use a hyphen to connect the adjective to the noun in compound expressions.7.

Break the writing up into short, readable sections. 8. Use stacked lists and visuals if appropriate. 9. Make your writing cohesive and easy to follow. End e-mail, memos, and letters with an action statement. Use titles and headings in longer writing. Follow the accepted formats for different types of writing.

A Handbook for Technical Writers and Editors on many rules of grammar, punctuation, and capitalization; these rules are constantly changing (as is our whole language); and these rules (when they of ideas, nor will following all the rules ensure effective writing.

Rules in technical writing

Effective writing requires good syntax, that is, an effective arrangement. Feb 03,  · Filed Under Communication, Golden Rule, Technical Communication, Technical writer, Technical writing, technology, videogames, Writing and Editing It was a refresher to spend a friday evening listening to Leah Guren sharing her insights acquired from a 30 year old career in Technical communication.

7. Break the writing up into short, readable sections. 8.

Rules in technical writing

Use stacked lists and visuals if appropriate. 9. Make your writing cohesive and easy to follow. End e-mail, memos, and letters with an action statement. Use titles and headings in longer writing.

Follow the accepted formats for different types of writing. Technical writing is nothing if it’s not about discipline, precision and consistency.

That’s how tech writers impose order on disorder. One of the most basic we impose that order on an otherwise unruly collection of information is the application of stringent punctuation rules. When sentences.

Write clearly [] |George Orwell's general writing rules work for technical writing. Never use a metaphor, simile, or other figure of speech you are used to seeing in print.

Never use a long word where a short one works.

Back to Basics – The 10 Golden Rules of Technical Writing | World of a Technical Writer