Welcome once again to my friend and colleague, Janice Hamrick, with her latest perspective on helping whole development teams attain agility through effective technical writing. Unfortunately, technical writers, who are crucial members of the product development team, are often siloed for the sake of "efficiency." I've been serving my teams for years by insisting that stories are not complete until there is adequate documentation, and it has driven dramatic positive changes from the perspective of people, product, process, and tools. If you like this post, please check out her other two posts (How Agile is Like a Guitar and Tech Info Fits Into Agile Software Development and 3 Ways to Make Documentation as Agile as Development).
~@MulticastMatt
Some development teams choose to separate documentation from the rest of the development work. In fact, the Society for Technical Communication (STC) recently held a seminar entitled, “Doc Sprints: The Ultimate in Collaborative Doc Development,” which included the following description:
“Many technical writers find themselves in agile environments, where time is at a premium and it can be difficult to pry the developers and other subject matter experts away from their day-to-day deadlines.”
The problem with this practice is that it violates almost every principle of Agile and causes problems for all members of a team.
What is a “doc sprint” as opposed to a sprint?
A doc sprint is just that – a sprint containing only documentation tasks. Often, the only member of the sprinting team is the writer, with nonexistent or at best nominal support from the rest of the team. Dev and Doc are like milk and cookies - they should always go together. If you are having separate doc sprints that lag behind development sprints, YOUR TEAM IS NOT AGILE. Documentation is as important to software development as coding and QA - no story is done unless it’s fully coded, tested, and documented.
Why should it be difficult to pry developers away from their deadlines?
If your team is truly Agile, EVERY team member is responsible for every user story. This means that developers are as responsible for providing content and reviews as they are for coding. If a writer is blocked and a doc task can’t be completed, then the story can’t be closed. This provides the means and the motivation for excellent communication and cooperation among all members of the team, and ensures the documentation gets the attention it needs from all concerned. If a team conducts separate doc sprints, dev and QA have already moved on to something else by the time the writer starts and will have to switch context to provide information. Moreover, dev and QA very likely have not budgeted time into their own sprints to work with the writer – after all, their stories apparently can close without documentation. This leaves the writer in the uncomfortable position of “prying” developers away from their “real work” or resorting to begging (or threats). Plus, the likelihood of missing information altogether (because it’s no longer current) or of being shortchanged during review cycles increases astronomically. The doc quality suffers, team relationships suffer, and ultimately product quality suffers.
Why are writers different from any other team member?
The short answer is that they shouldn’t be! However, in many organizations, tech writers report to a different business unit than development teams, a situation that can leave writers feeling like outsiders because they are treated like outsiders. I know writers who are left off mailing lists, who aren’t included in team-building training, and who are sometimes the last to know about feature changes.
For real Agile success, writers must be real team members. It might not be possible or even desirable to change the management hierarchy of your organization, but it is possible for teams to ensure that writers are first-class team members. The first steps include making sure everyone on the team understands this (management support is essential), eliminating doc sprints, ensuring doc tasks are part of the team user stories, and planning for the time needed to provide content, write, and review the doc.
Is there ever a good reason to have a doc sprint?
Probably not. There might be a reason occasionally to have a doc-only user story (for example, if your team decides the product needs a new user guide), but even in that case the team is responsible for content and reviews. No one team member, whether writer or not, ever works in a vacuum. All stories require commitment by the team, and as such should be incorporated into team sprints.
Your thoughts?
Does your team hold separate doc sprints or are your documentation tasks integrated into the development sprints? How does that work for your team and the quality of your product?
About the Author
Janice Hamrick joined CA Technologies in 2010 as the Senior
Technical Information Engineer for the Capacity Management suite of products
(formerly Hyperformix). Before joining
Hyperformix, she spent years writing documentation for backup and recovery
products for a rival company whose three initials shall remain unnamed. It is a
myth that she has worked as a technical writer in the software industry since dinosaurs
roamed the earth, but she does remember when “agile” was something you had to
be to avoid the saber-toothed tigers.