4 Levels of Editing in Technical Writing

Writing is re-writing; that is, editing. Technical editing is a crucial part of all technical writing projects. But we have to remember there are multiple levels of technical editing which makes the task all the more challenging. LEVEL 1 EDITING Spec Editing. Does the document satisfy all the macro requirements specified in the Documentation Plan?…

Read More

3 Standard Operating Procedures (SOP) Methods

A Standard Operating Procedure, or SOP for short, is documentation that provides step-by-step instructions on how to carry out a task. These are frequently used by all organizations, including small businesses and larger corporations, to ensure quality results with daily tasks. Creating Standard Operating Procedures (SOP) can seem like a daunting task, but it doesn’t…

Read More

How to Use a Database to Store Content

(Excerpt) Using a database to store content has some big advantages. Assuming it is set up and managed correctly, and that users (procedure writers, content creators, etc.) can find, edit, and extract the content they need for a particular document, it can offer value in being able to ’single-source’ certain reusable content, and to separate…

Read More

Pros and Cons of Working as a Remote Writer

Working as a remote writer might sound like a dream job, but it can also have its downside. One of the main challenges is that you’re not surrounded by coworkers on a day-to-day basis. The following are some of the pros and cons of working remotely: Pros of Working as a Remote Writer: Remote writers…

Read More

How to Write Web Content with SEO in Mind

SEO (Search Engine Optimization) is a “necessary evil” for most writers and I agree with them. It’s not easy to write with SEO in mind because that brings in yet another level of discipline and complexity to a craft that is already complex and hard in many ways. But, on the other hand, if you…

Read More

How to Split and Simplify Your Complex Sentences

© 2009 Ugur Akinci Here is a sure-fire method to split your long sentences into shorter and more easily understandable ones: Split your sentences at conjunctions like “and”, “or”, “while”, “however”, “although” etc. Those are the connection points where one clause is linked to another. By breaking your clauses apart you can develop a simpler…

Read More

How to Eliminate Redundant Words from Your Writing

© 2009-2010 Ugur Akinci Repeating an idea has its rightful place in article writing, essays, or journalistic writing. Even if you’re writing a technical article for engineers and scientists it pays to express the main idea once in the header (a must), then in the sub-header, another time in the opening paragraph, and lastly for…

Read More