Technical writing

From Wikiexpert

One of my services is to produce technical software specifications and diagrams. If you can't draw it, you can't do it, is what I tell my clients. I love infographics, and one of my side projects is the website http://www.grafaq.com.

Often times, I am requested to create documentation for a website that has all ready been created. When I do this, I skip the following steps, and go straight to documenting the existing software.

Here are the steps I go through in creating a spec.

Define The Purpose of the Documentation

Here is where I identify the potential audiences of the documents that I am creating.

Identify Entities

The next thing I do is get a list of all users, roles and entities that are players in the process.

Identify Responsibilities

A natural follow up to the Entities, I basically define the Roles (nouns) with the Responsibilities (verbs).