Member-only story
The Technical Writing Team
Documentation is not a one-person show
When we think of technical writing, we think of a lone soul in a cubicle, pounding away at the keyboard. Days later, the lone soul emerges from a long-locked door, with a final manuscript in hand. We cheer!
In my real world, the better writers are looking for feedback from trusted helpers as their project moves forward. While the principal writer may do 90% of the work, but the insights gained from discussions as the work is in progress are essential to create a better document.
Technical writing should be a team project. Here are the team members.
The Subject Matter Expert (SME)
The SME has the most understanding of the topic. This person should be setting the direction and destination of the document.
The Principal Writer
This is the person with the writing skills. The SME can be the principal writer, but often the SME has other obligations and distractions. Being able to hand the bulk of the writing to another person is often more practical.
The Structural Editor
This person should be brought in after the first draft is finished. This person will have some different insights about…