Technical writing
LMS International Samtech Metris
Ubizen Ingram Micro S.W.I.F.T
Copy writing
Namahn
Amplexor
ESN
Editing
Thompson International Media
LMS International
|
Joanna O'Kelly has more than 15 years
experience in technical writing, editing and preparing for
publication.
Some truths about software documentation are:
- managers assume developers can write it
- developers hate writing it
- users know what they are doing and don't need documentation
- good documentation can add enormous value to complicated
software
When producing technical documentation I take pride in
- explaining complex subjects
- meeting deadlines
- writing from the user's point of view - not the developers
- ensuring the user can find his way around the documentation
- using clear language that can be understood by readers whose
mother tongue is not English
- using good writing styles and practice
- checking accuracy completeness and presentation
|
Skills and tools
Word
FrontPage
Arbortext XML editor
Framemaker
Publisher
Quark Express
RoboHelp
Doc to Help
Photoshop
CorelDraw
Corel Photo Paint
Acrobat Distiller
DITA
XSLT |