Online Video Courses

FrameMaker template

Basic Software Documentation Terms Every Tech Writer Should Know

By Ugur Akinci | May 20, 2015

Introduction It helps to know Basic Software Documentation Terms if you’re documenting any software product. It cuts down on your preparation time and saves you from getting those “funny stares” from the developers/engineers when it becomes apparent that you don’t know what you’re talking about. Rule of Thumb Always do your homework first and get…

Read More

How to Write Goal-Focused and Structured Technical Documents

By Ugur Akinci | May 18, 2015

PREMISE Most of the technical documentation that exists in the world today is feature-focused. It is also unstructured: there is no well-defined hierarchy between the components of the document. For example, there is no enforcement of a hierarchical rule like “every task description shall be followed by a reference section.” See this related article. PROBLEM…

Read More

Avoid “Double Possibility” in Your Statements

By Ugur Akinci | May 13, 2015

When copywriting, avoid double possibility in your statements. That’s the fundamental rock on which all copywriting stands. George Bernard Shaw once wrote a very long letter to a friend and ended it with the following post script: “Sorry, I didn’t have the time today to write you a short letter.” Clean technical writing is easy…

Read More

Construct Sentences that Do Not Require Mental Inversion

By Ugur Akinci | May 11, 2015

© Ugur Akinci When we construct a procedural sentence in technical writing we are usually telling the reader either to do something or not to do it. Our intention is either pointing out to something positive or negative. For easier comprehension and longer retention, try to construct your sentences in a way such that the…

Read More