https://DevOpsCloud.io -- Cloud Monk Losang Jinpa

Return to Insider's Guide to Technical Writing, Technical Writing, Technical Writing Bibliography, Writing Bibliography, Writing, Writing Topics, Awesome Tech Writing

Fair Use Source: B09X2CHHB1 (InGdTecWrt 2022)

“Technical writing is no different from many other careers: you learn your craft, you get started, you build momentum, and then you decide where to go from there. This book follows the same pattern.” (InGdTecWrt 2022)

Part 1. Is This the Job for Me? orients you in the tech writing field by explaining what the job is all about, the skills you need to succeed, and how you can get into the profession.

Part 2. Building the Foundation, discusses the basics of technical writing and the different types of documentation you’ll be expected to deliver. Perhaps the most important consideration is understanding your audience, and a whole chapter is dedicated to helping you do that.

Part 3. The Best Laid Plans, provides a lot of information about the different types of processes you might need to follow, and then helps you drive your own process and learn how to create a schedule. It includes tips on learning the products and technology about which you’ll be writing as well as information about the tools you’ll be using to produce the documentation.

Part 4. On the Job, is all about doing the job. After reading this, you’ll have a good idea about what it’s like to walk into a new tech writing job and start being productive right away. Chapters include advice on gathering information, actually writing documentation, and working with reviewers.

Part 5. The Tech Writer Toolkit, contains information about some of the extras for which a tech writer is often responsible. You’ll get help on creating a style guide, index, templates, and layouts, and on managing translation and localization work.

Part 6. I Love My Job, I Love My Job, I Love My Job… takes a look at what it’s like to be a technical writer. You’ll gain some insight into the ups and downs of life as a tech writer. Then I wrap up The Insider’s Guide to Technical Writing with ideas of where to go from here as you continue and grow in your chosen career.

Appendixes include a glossary to help you understand the terms used in this book and in the field, along with lists of useful books and websites. You’ll find plenty to help you continue with your self-education.“ (InGdTecWrt 2022)

---

Part 1. Is This the Job for Me?

Chapter 1. Calling All Tech Writers

Making a Living

Making a Difference

Chapter 2. 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

Chapter 3. Having the Write Stuff

But Can You Write?

Juggling Flaming Sticks

Getting Along

Being Dependable

Chapter 4. Breaking Into the Field

All Roads Can Lead to Tech Writing

Degree or Not Degree? That Is the Question

What the Employer Wants Is What You Want

But First, Are You Experienced?

Making the Most of What You Have: For the Career Changer

Why Is It So Hard to Get an Interview?

Network, Network, Network

Winning Interview Tips

Part 2. Building the Foundation

Chapter 5. 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—Is It Really the Hobgoblin of Little Minds?

Chapter 6. Best Practices Make Perfect

Best Practices all Point to Clear Writing

The Best of the Best Practices

Easy as 1, 2, 3: Writing Procedures

Show Some Respect

Chapter 7. 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…

Section 508 Compliance

Chapter 8. The Deliverables

Building the Documentation Family

Combining It All: Single-Sourcing and Content Reuse

Determining the Content Approach

Delivering the Deliverables

Part 3. The Best Laid Plans

Chapter 9. Process and Planning

Step by Step to Final Documentation

Understand the Development Process

The Documentation Plan

Chapter 10. Become Your Own Subject Matter Expert

The Importance of Product Knowledge

Put the “Technical” in Technical Writing

It Takes Time

Chapter 11. 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

Chapter 12. You Want it How?

Today’s Tech Writer Carries a Big Toolbox

Location, Location, Location

The Right Tool for the Right Job

XML

Go Green—Reuse Your Content

Books and Other Narrative Material

Graphics Illustrate Your Point

Writing for the Web

Developing Help

Multimedia

Going Above and Beyond the Basics

Part 4. On the Job

Chapter 13. Getting Started

New Kid on the Block

Ask About the Style Guide

The Care and Feeding of Your First Project

Making Your Deadlines

Finishing the First Assignment

Ask for Help

Chapter 14. Gathering Information

Scavenger Hunt

Read, Read, Read

Listen, Listen, Listen

Keeping Up

Chapter 15. Putting It All Together

Following the Rules

Jump Right In, The Water’s Fine

In the Beginning: Creating an Outline

Help Is Not Linear But Sequence Matters Nonetheless

Drilling Down

Fleshing Out the Outline

Drafting Your Draft

How Fast Is On Time?

Polishing the Rough Edges

Battling Writer’s Block

Chapter 16. Everybody’s a Critic—Reviews and Reviewers

Reality Check

It’s Not Personal

Choosing Reviewers

Educate the Reviewers

Sending the Draft Out for Review

Gathering Review Feedback

Consolidating Reviewer Feedback

Once More, with Feeling

Change Management

Thank Reviewers for their Contributions

Chapter 17. Wrapping it Up

Testing, Testing…

Rewriting and Editing

A Final Delivery Checklist

Freezing the Documentation

Hold that Freeze!

Sign Off

Send Off

Part 5. The Tech Writer Toolkit

Chapter 18. 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

Chapter 19. Front and Back Matter: Or Do They?

Let’s Be Upfront

About Back Matter

Chapter 20. 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

Chapter 21. Gaining a Global Perspective: Localization and Translation

Finding a Good Translation Company

Translation Versus Localization: What’s the Difference?

Developing a Global Awareness

The Translation Glossary

Writing for Translation

Managing the Schedule

The More Ways You Have to Say Thank You, The Better

Part 6. I Love My Job, I Love My Job, I Love My Job…

Chapter 22. Working Outside the Box

Working From Home

WFH: The Other Side

Consultant or Captive?

Chapter 23. I Didn’t Think It Would Be Like This!

The “Dark” Side of Technical Writing

Taking Control

Chapter 24. Managing Your Career

Moving Up

Keeping Score

Moving Around

Moving Out

Keep Your Knowledge Current

Moving into Another Field

Networking Doesn’t Stop Just Because You’re Employed

The Future Belongs to You

Appendixes

Appendix A. Tech Talk: The Tech Writer’s Glossary

Appendix B. For Your Bookshelf

Style Guides

Writing Resources

Tools and Technology

Content Design and Planning

People and Project Management

And More

Appendix C. Websites

Writing Resources

Structured Content

Sites to Help Build Your Portfolio

Networking and Job-Hunting

Organizations and Conferences

Technical Dictionaries

The Lighter Side of Technical Writing

Miscellaneous

• Insider's Guide to Technical Writing Index

Fair Use Sources:

• Insider's Guide to Technical Writing on DuckDuckGo
• B09X2CHHB1 (InGdTecWrt 2022)