Drafting and re-drafting

Now, it’s time to start writing. Much like any other form of writing, one draft is rarely enough. Once you have a first draft, you need to get all involved stakeholders to take a look and give their input. This process can take some time, but it is important to ensure the correct balance of technical accuracy, company priorities, and language clarity.

This chapter won’t focus on tools for doing this, but the process. There are several well-established toolchains for reviewing technical copy that influence the advice I give, but I try to remain as agnostic as possible.

Getting rounds of feedback on documentation can directly correlate to your ability to extract the expectations and assumptions mentioned earlier. If these were not clear in the earlier stages, then this likely becomes evident during feedback. Sometimes, this is because you misunderstood or incorrectly assumed something communicated with you, or more often than not because people...