While we we were recording an episode of The WordPress Way at Do the Woo about The Importance of Product Testing in WordPress, guest Brian Alexander did a quick note in the chat tool we use during a recording, simply saying, “Documentation is a gift to the community.” Host Abha Thakor asked him to elaborate on that.
Brian: Yeah, consider someone who is not as familiar with WordPress or is having a problem with their website or is a developer who’s just getting started. All of those different roles benefit from having strong updated documentation. Think of how many forum posts might not have been logged because it was clearly stated how to use a particular feature in the documentation or perhaps uncovering bugs as you said, because that’s all part of it. Validating your documentation in a way you’re testing what your assumptions are and if those assumptions are incorrect, then you’re assuming the wrong thing or there’s a bug in the system.
So that definitely becomes a gift to the entire community as a resource that doesn’t require one-on-one time or tying up one person. It’s very inefficient for one person to answer all the questions.
Leave a Reply