Archive for 2011
The Discipline of Punctuation in Technical Writing
© Ugur Akinci Today let’s talk about the discipline of punctuation 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…
Read More2 File-Naming Tips for Higher Productivity
Every technical writer at some point in his or her career faces this problem until a solution is found: too many files thrown together in a folder, without any easy way to tell which is what. Here are some of my own file naming tips that have helped me a lot over the years. File…
Read More
7 Tips to Write Effective Technical Magazine Articles
Introduction Writing effective technical magazine articles could be great to heighten your visibility as a technical writer. There are many respectable industry magazines and journals like STC’s INTERCOM where you can try to publish your articles both to share your valuable knowledge with the vast technical writing community out there and to market your services…
Read MoreMust Concepts for Software Document Writers
© Ugur Akinci It helps to know what the following are if you’re documenting any software products. 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…
Read More3 Tips for Writing 10-K Annual Reports for U.S. Corporations
Writing Form 10-K Annual Reports is a lucrative niche that you should consider if you have a finance or investment background or feel comfortable with terminology of economics. Here is a great web site where you can go and take a look at hundreds of annual reports filed each year by U.S. SEC (Securities and…
Read MoreAuthorIt SaaS Cloud Enterprise-Level Technical Writing Platform – Selected Features
© Ugur Akinci Here are a few really cool AuthorIt features that caught my eye during a recent webinar demonstration by the company founder and CEO Paul Trotter. Searching for Content AuthorIt is a powerful structured-authoring editor that allows you to use the same chunk of content many times over. So searching for reusable content…
Read More"I’m a journalist. A reporter… Can I become a successful technical writer?"
Can a journalist become a successful technical writer? I don’t see why not. I was a journalist once upon a time too. After I made the switch to technical writing, I never looked back. Two Skills of Journalists Journalism teaches you mental concentration and time-discipline. When you’re working as a reporter for a daily newspaper…
Read MoreU.S. Federal Government as a Source of Employment for Technical Writers
The U.S. federal government is a major source of employment for technical writers, as the government employs more than 7,000 writers who produce manuals and instructions for federal agencies and departments. Technical writing is a field that requires an understanding of the subject matter being written about, as well as the ability to communicate clearly…
Read MoreSurvey: British Office Workers Hate Business Speak
If you’re miffed to hear hackneyed expressions like “think outside the box” you’re not alone: a lot of office workers in Britain reported they also can’t stand the expression, according to a British survey of 2,000 cubicle dwellers. Tweny five percent of those surveyed ranked “blue sky thinking” and “hit the ground running” as number…
Read More10 Principles for a Great Technical Tutorial
I’ve compiled these 10 Principles for a Great Technical Tutorial on the basis of my experience as a technical writer who worked for Fortune 100 companies for over 20 years. As a technical writer you may be asked to write and design on-line tutorials on topics ranging from how to set up a customer service…
Read More