User Training

Over the past twelve years, in some way, I have participated in the development of user manuals for computer software.
It has been an enlightening experience and I feel like I have received an opportunity that perhaps was not necessarily available to others.
I first worked as a computer trainer in Brazil and then when I [...]

Dr. Explain Help Authoring Tool

The Internet today is amazing, and just keeps getting better. Recently, I had the good fortune of crossing paths with Dennis Zhuravlev (a.k.a. Crane) of Samara, one of the largest cities of Russia, and that sits alongside the east bank of the well-known Volga River.
Dennis is an accomplished applied mathematician and computer scientist [...]

Backing Up Your Files

For those of you who do much file updating or create new files each day, today’s post is a simple reminder.
BACK UP YOUR MOST IMPORTANT FILES DAILY.
Do you know how hard it is to recreate a document? Let me tell you something, after spending a whole day on a document, and getting a meeting with [...]

Thank You Les Paul

On Thursday, August 13th, a great man passed away by the name of Lester William Polsfuss, also known as Les Paul. His life was a source of inspiration for many, including me. He was not only a great guitarist, but was also the innovator behind the modern electric guitar sound and Gibson Guitar itself stood [...]

The Purpose of a Resume

The purpose of a resume is simple: to get you a job interview. At the job interview, the interviewer can get to know the individual firsthand. So, to make a long story short and get right to the chase, the purpose of a resume is to gain the interest of the reader and show the [...]

Capitalization

Capitalization may correctly be said to be the “holy grail” of technical writing. Why do I say this? It is because technical writers must face many, many technical terms and “know” how to correctly document these terms, without constantly contradicting rules that apply to basic grammar and writing.
In fact, this issue is so [...]

Creative Documentation

The title of this post is “creative documentation”. I am sure you are wondering “what is this?” Well, let me first say that writing documentation is not rocket science. In fact, the entire process of software development, from initial specifications to system design to coding to documentation to testing, implementation and use is as unique [...]