Book Companion Webpage
A Real World Guide to Managing
Technical Documentation

Contents

    Site Home
   +Outline <-
    Sample Chapters
    Book Extras
    Mailing List
    Feed

Managing Writers: Outline

Outline

The book has twenty one chapters in four parts: Getting Started, Managing People, Managing Projects, and Managing Technology. The front matter includes a preface and acknowledgments, and the back matter includes an appendix, a bibliography, a glossary, and an index.

In this outline, parts are shown with Roman numerals, chapters with Arabic numerals, and sections/sub-sections with bulleted lists.

Part I: Getting Started

  1. Introduction. 

    Describes how I became a documentation manager, and how I was “educated” by my team. Sets the stage for the style of the book.

  2. The Elements of Technical Writing. 

    A high level overview of technical documentation for those who without a background in technical communication.

    • The Product

    • The Developers

    • The Audience

    • The Tasks

    • The Deliverables

    • The Environment

    • The Schedule

  3. Power and Influence. 

    The definitive management challenge for documentation is power; documentation groups never have enough. This chapter describes several ways to increase your leverage and influence.

Part II: Managing People

  1. Working with Human Resources. 

    • The “Good Old Days”

    • The HR World Today

    • When You Must Work with HR

    • Maintaining a Good Relationship with HR

  2. Hiring. 

    • What makes a great technical writer?

    • Evaluating a candidate.

      • Evaluating Résumés

      • Checking the Web

      • Conducting a Phone Screening

      • Conducting an Interview

      • Evaluating Writing Samples

      • Checking References

    • Using Contractors and Contract Services

    • Off-shoring

    • Managing the Hiring Process

  3. Motivating. 

    • What Does it Mean to Motivate?

    • Common Demotivators

    • Removing Demotivators

    • Building a Motivated Team

  4. Managing Change. 

    • The “Burning Platform”

    • The “Change Function”

    • Leading Change

  5. Evaluating Employee Performance. 

    • The “Ritual”

    • Gathering Input

    • Writing the Evaluation

    • The Employee Discussion

    • Handling Difficult Situations

    • Ranking and Rating Employees

Part III: Managing Projects

  1. Development Methodologies. 

    • Project Methodologies

    • Specialized Methodologies

  2. Project Planning. 

    • Rules of Thumb

    • Defining Objectives

    • Creating Schedules

      • Managing the dimensions of scheduling

      • Scheduling deliverables

      • Estimating effort

      • Identifying dependencies

    • Assumptions, Risks, and Contingencies

    • Assigning Resources

    • Combining Schedules

    • Dealing with Unreasonable Schedules

    • Writing the Plan

  3. Tracking. 

    • Basic Tracking

    • Advanced Tracking

      • Tracking up

      • Tracking across

    • Early Warning Signs

  4. Measurement and Metrics. 

    • The Impact of Measurement

    • Management Strategies

    • Measurement Strategies

      What to measure, who should measure, and how to use measurements.

  5. Localizing Your Documentation. 

    • Internationalization, Localization, and Translation

    • Scheduling Localization

    • Minimizing Translation Costs

Part IV: Managing Technology

  1. Living with Technology. 

    A set of basic guidelines for living with technology.

  2. Acquiring Technology. 

    • Defining the Problem

    • Defining Requirements for a Solution

    • Writing the Requirements Specification

    • Working with Vendors

  3. Building a Business Case. 

    • Business Case Basics

    • Profit Centers and Cost Centers

    • Writing the Business Case

    • Caveats and Limitations

  4. XML Technology. 

    • The Origins of XML

    • Key Concepts

      • XML Schemas and DTDs

      • Descriptive Markup

      • Data Independence

    • XML Pros and Cons

      • Reasons to Use XML

      • Reasons Not to Use XML

    • Choosing an XML Schema

  5. Using the Internet. 

    • Where are You Starting From?

    • Developing Content for the Internet

    • Getting the most out of the Internet

    • Web 2.0 and Beyond

  6. Content Management Systems. 

    • Content Management Concepts

      • Organizing Content

      • Storing and Retrieving Content

      • Sharing Content

      • Publishing Content

    • Workflow Management and Collaboration

    • Content Management Systems

      • Essential functionality

      • Additional functional

      • Selection guidelines

      • Rolling your own

      • Information architecture on a shoe string

  7. Avoiding common pitfalls. 

    • Misunderstanding or Ignoring Your Real Needs

    • Misunderstanding Your Users

    • Misunderstanding Your Requirements

    • Misunderstanding Your Processes

    • Ignoring Your Intuition

    • Underestimating the Cost of Change

  8. Epilogue. 

    Final thoughts.


$Date: 2008/05/05 19:20:16 $Home | About...Feedback
Copyright © 2007, 2008   Richard L. Hamilton.