A wise philosopher once said ” Life moves pretty fast. You don’t stop and look around once in a while, you could miss it.” OK, it was Ferris Bueller, but the sentiment is true. It also applies to software development projects. They might take awhile to get started but once they’re rolling, it can be hard to keep up.
It’s a dynamic process and things change along the way. Often, a design will change enough that additional documentation is required. Or you may realize that a certain feature is going to require more topics than originally thought. Your content outline is a living, breathing thing and it grows with the project.
So, to update or not to update the documentation plan? That is the question. And I don’t really have a good answer. Clearly, in an ideal world, you would keep the documentation plan updated on a regular, maybe even daily, basis. But in an ideal world, you probably wouldn’t have to worry about the documentation plan because you’d have had all the information upfront, nothing would have changed, and you’d have gotten the project scoped exactly right.
We don’t live in this mythical ideal world, so what do we do in the real world? I’d say, it depends. If you have time, absolutely, that’s a no-brainer – update the project. But chances are, you’re not going to have a lot of time.
Then you should base your decision on the extent and impact of the changes. If the content outline has changed significantly enough to require a lot more work for reviewers, find the time to update the documentation plan. (Also, you should inform your manager about the change whenever it involves extra work for reviewers. A few topics should be fine. A few chapters or more than 20 pages is probably not fine.)
At the very least, you should include some sort of note or warning in the doc plan to let readers know that it currently does not reflect reality.
Looking to improve your processes and your documentation? Contact Bardwrite to learn how we can help you.