Monthly Archives: February 2015

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

release notes template in ms word

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 […]

User Guide Checklist

This checklist summarizes the recommended structure and contents for User Guide documents. Introduction In this section, introduce the User Guide and cover the following areas: – Intended readers – identify the different user types, for example, system operators, home users, and experts. For each, identify the assumed level of experience and highlight the sections of […]

How to Test Technical Documents

This checklist helps you test User Guides and other technical documents. The first step is to ensure the following is in place. Setup the necessary technical environment. Make sure this reflects the user’s settings or as close to as possible. Print out the procedures. Follow the instructions as per the document. Aim to identify any […]