Category Archives: writing

Technical Writing – How to Write Project Justification Documents

As part of building the overall project scope a technical author will first need to lay out the justification documentation. This document which can also be considered a “business case” lays out the fundamental reasons for implementing the project. Here’s a simple guide on creating a project justification. State the Problem Businesses don’t carry out… Read More »

Technical Writing – Components Of Windows User Interface In Software Documentation (2) – Window

User interface documentation, one of the important tasks in software documentation, requires clear and consistent definition of all interface components. In this second part of the series, we continue with our survey of the most important interface components that a technical writer should be familiar with. NOTE: Windows, Mac and Linux machines all have different… Read More »

Components of Technical Writing – Why It Is Important To Keep the Audience in Mind

I’ve had quite a bit of experience dealing with technical writers within the auto industry, which other than space travel, encompasses about every type of technical skill known to mankind. These people, of course are all engineers and quite intelligent as far as book smart goes, and as the industry itself attempts to hire the… Read More »