Akorn Komputing acorn logo

 

Akorn Komputing

Paul Van Akkeren

Flag waving
Home
Up

 

Technical Writing

 
Philosophy

Know the audience and write to it.  Keep it simple.  Make sure all information is included.  Make it clear.  Do not forward reference (define every term, acronym, or activity the first time it is used).  Work with the audience.  Review and test the work.  Vary the reading with graphics and changing styles.

 

Types of Documents
Requirements Documents
Data Flows
Technical Documents (Compilations)
User Guides
Training Manuals
Grant Requests
Systems Analyses
Test Plans
How To Books
Technical Descriptions
Proposals
Business Analysis

 

 

  Resume (pdf format)

  

Samples

Technical Document - This is part of a document which is a description of an application and a collection of all technical information for the benefit of future programming efforts.

User Guide - This document is part of a user manual for an old main frame financial system used by many people of varying levels of computer literacy throughout many agency offices.

Grant Request - Abstract from a request to a large commercial entity for funding for an information technology initiative.

Instructor Guide - Portion of the Instructor's Guide of a course for operation of a large financial management system operated by a government agency.

Analysis Report - Portion of a systems analysis and recommendations to a government agency for operational automation.

Requirements Document - Portion of a requirements document for data acquisition software for the GEOS satellites (since replaced by another system).

Design Document - Portion of a design document for a Marine Corps environmental management system.

 

 

by: Paul Van Akkeren

Copyright 2001, 2002, 2003. 2004, 2005, 2006 Akorn Komputing
Last update: July 2006 All rights reserved