Configuration Guides: How To Document Parameters

So, you want to document the parameters for your new Configuration Management Guide. Where do you start? Here’s a checklist of what you need to capture when documenting parameters in technical documentation: Parameter Name Specify the name of the parameter with consideration to case sensitive naming conventions. Likewise, use the correct format and styling when […]

How to Find Broken Links in Madcap Flare

Tired of all those pesky broken links in your WebHelp projects? Wish they’d go away? Well now you can! If you use MadCap Flare to create your web help, you can run a broken link checker. It’s not perfect. But it will catch most dead links, which is a start. Finding broken links in Madcap […]

Madcap Flare: How to add The Mark of The Web

Using Madcap Flare for WebHelp? If you have problems getting Internet Explorer to run web help pages, added ‘Mark of the Web’ to your WebHelp files. Madcap Flare: How to add Mark of the Web You can add the Mark of the Web to HTML files so they run locally in Internet Explorer. In Project […]

How much can you make as a technical writer?

Right now, the average aalary of Technical Writing Job in the USD (May 13, 2015) is… low end 45k middle earners 90k high end        135k Here’s a fuller breakdown: Engineering Technical Writer $54,000 IT Report Writer $69,000 IT Technical Writer $74,000 Senior Proposal Writer $80,000 Technical Proposal Writer $69,000 Technical Writer $123,000 Technical […]

Over 50? Would a career in technical writing suit you?

If you have good writing skills, enjoy technology, and like to help others understand how things work, then a career as a technical writer might suit you. 1.0      Technical writer work/life balance Technical writing has been very good to me. It’s allowed me to work in China, London, San Francisco, and Amsterdam. Most of the […]

How to find technical writing work on LinkedIn

How much technical writing work have you got from LinkedIn? Ever? Let’s look at how to get more work, especially contract work, from LinkedIn. If you’re doing some of the following, let’s stop and think a minute. Are you in more than ten groups? Do you post to your own profile only but not to […]

Do you have a technical writer’s personality?

Considering a career as a technical writer? Want to know what kind of people enjoy technical writing the most? Would it suit your personality? Is being introverted an advantage? Can jovial types make it as tech writers? Yes and Yes. Crag on Helpscribe makes the point that, “Personality can also have a strong influence on […]

How to find technical writing work using Quora

Are you using Quora to find technical writing work? Maybe you’ve never heard of Quora. Here’s how it works. Think of it as a deluxe ‘Question and Answer’ site focused on the business community. A lot of influential people are there. It has almost no spam or nasty comments. If you want to develop your […]

How I use Twitter to find technical writing work

KB from London heard that I use Twitter to find work. Like many of us, she thought Twitter was a waste of time and ignored it. Maybe we can change her mind. How I use Twitter to find technical writing work Here’s how I use it. Create a twitter account for your business. Add a […]

C# Namespace Guidelines

Let’s create some guidelines for documenting .Net Namespace. For example, let’s look at the System.Collections Namespace. What do we notice? Namespace – define the namespace using the following convention: System.Collections Namespace Purpose – describe the purpose of the namespace, for example:   The System.Collections namespace contains interfaces and classes that define various collections of objects, […]

What is a Statement in C#?

In C#, statements express the actions that a program takes. Common actions include Declaring variables Assigning values Calling methods Looping through collections Branching to another block of code The order in which statements are executed in a program is called the flow of control or flow of execution. This may vary every time that a […]

How to Write Error Messages: Faster, Stronger, Better

Blame the cat, TV, or the neighbors if you want. The thing is: stuff happens. When it does, you need some way to fix it, pronto. Aren’t  I right? This is where error messages can save you bacon. No one thinks of writing an error message guide until it’s too late. So, I’m telling you […]

C#: how to write Hello World

The “Hello, World” program is traditionally used to introduce a programming language. Here it is in C#: using System; class Hello { static void Main() { Console.WriteLine(“Hello, World”); } } What’s the file extension? C# source files typically have the file extension .cs. How to compile? You can compile the program with the Microsoft C# […]

How to Write Release Notes: Faster, Stronger, Better

So, you want to write release notes but don’t know where to start? Well pull you a chair and let me give you the lowdown. Download – Release Notes template with sample text. Introduce the release notes with text such as the following: These release notes provide information about the documentation for <your product> <version […]

Proof-reading Checklist for Technical Documents

Is there anything worse than sending out an important document and then, just when it’s gone, finding a typo? Always leave some time to check your documents before you send them out. Here’s a checklist to get you started. Proof-reading Checklist Select the entire document – CTRL+A – then click the Language option at the […]