Technical Writing 101: A Real-world Guide to Planning and Writing Technical Documentation |
Contents
Preface | 15 |
An overview of the technical writing process | 31 |
The Tech Writers Toolbox | 47 |
Getting information | 59 |
Finallyits time to start writing | 75 |
Writing taskoriented information | 91 |
A few words about pictures | 105 |
Editorsresistance is futile | 121 |
Preparing final output | 165 |
The myth about images | 176 |
Think globally act locally | 187 |
Single sourcing | 189 |
Structured authoring with XMLthe next big thing | 213 |
Getting your first job as a technical writer | 227 |
Resources | 247 |
Tools information | 259 |
Common terms and phrases
Adobe Adobe Systems applications audience basic bitmap changes chapter client consider cross-references database deliverables desktop desktop publishing dialog box displaying doc plan docu documenta documentation plan documentation project editing element employer ensure Epic Editor example explain Extensible Markup Language Figure formatting FrameMaker freelancer graphics help authoring tools HiJaak hyphenation index entries Ingredient IngredientList interface interview legacy documentation look manual ment menu Microsoft Microsoft Word numbers online help outline output paper drawer paragraph printer printing probably problems procedure production editor programs readers recipe reference information requires running footer schedule Scriptorium Publishing SGML single sourcing skills source files structured authoring style guide style guidelines sure tags taking screen shots tasks Technical Communication technical documentation technical editor technical writers template designer tion topics WebWorks Publisher What's Windows Winkle Wart Technologies word Workbook