دانلود کتاب the INSIDER'S GUIDE TO TECHNICAL WRITING.

فهرست مطالب :

Front Cover
The Insider’s Guide to Technical Writing
Contents
Foreword
About this book
Part 1. Is this the job for me?
Calling all tech writers
What is a technical writer?
Where you’ll fit in
Show me the money
Making a difference
What does a technical writer do, anyway?
More than writing
Filling some big shoes
A day in the life
The technical writer is the first end user
Having the write stuff
But can you write?
Juggling flaming sticks
Getting along
Being part of the business
Being dependable
Breaking into the field
All roads can lead to tech writing
Degree or not degree? That is the question
The right tool for the right job
Are you experienced?
Making the most of what you have
Why is it so hard to land an interview?
Network, network, network
Winning interview tips
Part 2. Building the foundation
How to write good (documentation)
Correctness Is key
Completeness counts. Make sure nothing’s missing
Having a handle on usability
Clarity is in good writing
Consistency: not the hobgoblin of little minds
Style guides: not just a fashion statement
Best practices make perfect
Best practices all point to clear writing
The best of the best practices
Show some respect
It’s all about audience
Who will read the documentation?
Different users have different needs
One document, many users
So that’s the way they do it
Be accessible
The deliverables
Building the documentation family
Determining the content approach
Delivering the deliverables
Part 3. The best laid plans
Process and planning
Step by step to final documentation
Gathering requirements
Understanding the project management process
Project management methodology
The documentation plan
Become your own subject matter expert
The importance of product knowledge
Put the “technical” in technical writing
It takes time
You want it when?
Fast, good, or cheap. Pick two
Good enough has to be good enough
Battling your inner perfectionist
Get your speed on
Working with contractors
Making and following a schedule
You want it how?
Today’s tech writer carries a big toolbox
Location, location, location
Content management and content reuse
XML
Books and other narrative material
Graphics illustrate your point
Developing help
Multimedia
Writing for the web
Going above and beyond the basics
Part 4. On the job
Getting started
New kid on the block
The care and feeding of your first project
Making your deadlines
Finishing the first assignment
Asking for help
Gathering information
Scavenger hunt
Read, read, read
Listen, listen, listen
Keeping up
Putting it all together
Following the rules
Jump right in, the water’s fine
Shuffling the virtual index cards
In the beginning: creating an outline
Help is not linear but still has order
Drilling down
Fleshing out the outline
Drafting the draft
How fast is on time?
Polishing the rough edges
Battling writer’s block
Everybody’s a critic: reviews and reviewers
Reality check
It’s not personal
Choosing reviewers
Educating reviewers
Sending the draft out for review
Gathering review feedback
Consolidating reviewer feedback
Once more, with feeling
Thank reviewers for their contributions
Wrapping it up
Testing, testing
Rewriting and editing
Change management
Revisions
Part 5. The tech writer toolkit
The always-in-style guide
What makes a style guide such a hot property?
Style equals speed
Guideline or requirement?
The classics are always in style
Creating a style guide
Procedure guides
Front and back matter (Or do they?)
Let’s be up front
About back matter
Indexes
Design and layout
Whose job is it, anyway?
Enhancing usability with visual elements
Creating a template
Designing the page
Color me interesting
The final layout
A global perspective
Finding a good translation company
How much should be done in house?
Translation versus localization: what’s the difference?
Developing a global awareness
The translation glossary
Writing for translation
Managing the schedule
Translation management system?
The more languages, the better
Part 6. I love my job, I love my job, I love my job
Working outside the box
Working from home
The other side of WFH
Consultant or captive?
I didn’t think it would be like this!
The dark side of technical writing
Taking control
Managing your career
Moving up
Keeping score
Moving around
Moving out
Keeping your knowledge current
Moving into another field
Networking doesn’t stop just because you’re employed
The future belongs to you
Appendixes
Appendix A
Appendix B
Content creation and strategy
Globalization
People and project management
Structured content
Style
Tools and technology
User experience
Appendix C
Accessibility
Building your portfolio
Networking and job-hunting
Online communities
Organizations and conferences
Structured content
Technical dictionaries
Writing resources
...and more
Index
Back Cover