Treat documents like software

This is a followup to my earlier article about Agile and documentation projects.

I’m currently working on a document in which I’m outlining a group of processes within our application. My manager sent me a JIRA ticket to track the project. The ticket includes a few sub-tickets to track some of the specifics of the project.

It then occurred to me how we’re able to make documentation projects work in an Agile environment. It’s something I’ve been espousing for a while; in fact, I even make mention of it in my documentation presentation. I even made mention of it when I presented it a couple of weeks ago. (Ed. note: I wish I’d thought of this when the gentleman asked me this question at that user group meeting!) As it turns out, the answer is pretty simple.

The answer: treat documents like software.

Too often, documentation is treated like a second-class citizen. It gets absolutely no respect. That lack of respect is why I travel to SQL Saturdays preaching the gospel of documentation. Documentation is an important piece when it comes to technology planning; yet it is often treated as an afterthought.

In my current working environment, what makes document projects work in Agile is that they are treated with the same level of importance and respect as application updates. In a sense, document updates are application updates. They are important for end-users and developers alike.

In my daily Scrum meetings, I discuss progress made on my projects — almost entirely documentation projects. These projects are discussed on the same level as application and database updates. Tickets are created and tracked for these projects — just like applications.

I’ve had the luxury of having worked in both professional software development and technical writing environments. I can tell you from firsthand experience that the development lifecycle between the two environments is no different. So why do technical managers keep insisting on treating documentation differently? We are able to make documentation work because it is treated on the same level of importance and respect as application updates. Granted, it might be handled with a lower priority level (that’s okay), but the way documentation is handled is no different from the application.

If you want your documentation to be successful, consider it at the same level as you would your software development. It is a critical part of technology development, and it needs to be considered with the same level of respect.

2 thoughts on “Treat documents like software

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

This site uses Akismet to reduce spam. Learn how your comment data is processed.