Mapping the Field of Technical Writing

Updated 24 March 2007.
Further updated 10 April 2007.
Minor edits 6 May 2007.

Language skills

grammar

spelling

punctuation

editing

brevity

Plain English, jargon-busting

rhetorical techniques, persuasive writing

writing for an international audience

organising and managing translations

vocabulary

writing for an audience, reader empathy

Experience with different ‘genres’ (types of deliverable)

policies and procedures

tenders

marketing material

specification documents

manuals

reports

maintenance documentation

quick reference guides

training and support materials

on-line help

Analytical skills

coming to grips with complex concepts

extracting information from technical data

asking intelligent questions, interviewing subject-matter experts

searching for information

organising information

audience analysis

indexing, classification, categorising, structuring

end user/audience analysis

information analysis

information architecture/structure

People skills

interviewing and other (legal) methods of extracting information

cultural sensitivity

Tools

word-processing (Word, FrameMaker, Write, WordPerfect, LaTeX, etc)

on-line documentation tools (RoboHelp, etc)

web editing tools (Dreamweaver, FrontPage, HTML editors)

content management systems (AuthorIT, TeamSite, Vignette, Documentum, Zope)

screen capture and recording (HyperSnap, SnagIt, Captivate, Camtasia)

spreadsheets (Excel, Calc, etc)

presentation tools (PowerPoint, Impress, etc)

database tools (Access, etc)

desktop publishing (Publisher, InDesign, etc)

graphics editors (Illustrator, CorelDraw, Visio, PhotoShop, ……)

version management software (VSS, Subversion, etc)

video and film-making equipment/editors (FinalCut Pro, Adobe Premiere)

Graphics

familiarity with the basic concepts and methods of graphics software (including the distinction between vector-based and raster-based graphics)

knowledge of formats used for storing graphical data

Design skills

presenting information

visual layout

formatting

Document management, QA

version control

implementation of QA systems

use of version management software (see above)

user interface design and manipulation

Standards and Legal Requirements

familiarity with specific industry standards

implementation of standards

creating and using style guides

templates

Subject-specific knowledge

engineering background

IT concepts and terminology (programming, databases, networking, release management, ………)

financial concepts

medical concepts

Web design

basic concepts, use of Dreamweaver, FrontPage, etc

HTML

CSS

scripting (JavaScript, CGI scripting, ………)

advanced techniques (ASP, PHP, ………)

accessibility

heuristic analysis

Information management

content management

metadata

search algorithms

Training

devising exercises

e-learning

learning needs analysis

SCORM

adult learning concepts

assessments

Ancillary skills

business analysis

business processes, ITIL, Prince 2

software testing

programming

macros

documentation project management

financial

medical

indexing

interface design

user/usability testing

Publishing

knowledge of processes of printing (offset, bleeding, imposition, binding)