November Program Meeting: “Agile Technical Writing”

Jack DeLand explains Agile

Written by Susan Fisher

Agile is not your father’s (or mother’s) tech writing. It’s all about working with small chunks of content, being continually iterative, and understanding that it’s never really “done.”

STC-SM member Jack DeLand, a Certified Scrum Master and Agile practitioner, led the audience on a tour of the Agile development process and explained how technical writing fits into it. Most commonly used in computer software and systems development, Agile can be used with other types of development as well.

Traditional Development vs. Agile Development

In the traditional development process, comprehensive requirements and design specifications are created at the front end of a project. The entire product is then built and finally tested — followed by product-wide bug diagnosis and repair.

The Agile methodology is essentially about iterative, incremental development. Small functional chunks of the product are defined, designed, developed, tested, revised, and tested again until they are working properly. Then, these small chunks are combined into larger functional pieces using the same approach, until the product is complete. Development is a collaborative effort by cross-functional teams.

Flexible design, rapid prototyping, and quick adaptation to changing needs are hallmarks of the methodology. User input and usability testing are woven throughout the process.

What Does It Mean for the Tech Writer?

Instead of joining the project near the end, as is typical with traditional development, the tech writer on an Agile project is a member of the cross-functional team from the beginning. As such, the writer can play a key role in user needs analysis, design, usability testing, and the continual improvement of the product.

On the other side of the coin, the writer has to be comfortable with ambiguity, writing in fragments, innumerable versions of the documentation, and the reality that the product will continue to change until the end of the project.

It’s not for the faint of heart, but the rewards are worth the effort — and best practices have been, and continue to be, identified.

More Information

To learn more, Jack recommended starting with “Agile Technical Documentation” by Jean-Luc Mazet (http://writersua.com/articles/Agile_doc/index.html).

He also suggested visiting these LinkedIn groups:

  • ŸAgile Technical Writers
  • ŸTechnical Writers in an Agile Environment