4 ms·
> I've always wondered if there would be value in teams establishing an internship or low/mid level position for a technical writer to serve as a team librarian
by xtajv 6y ago
> I've always wondered if there would be value in teams establishing an internship or low/mid level position for a technical writer to serve as a team librarian
I disagree that this would be a low/mid level position. In fact, I think it would be one of the highest ranking technical positions on a team, on the level of "library maintainer".
Documentation is useful because it allows the writer to transfer their own mental model to the reader. Like any data transfer, the fidelity of the reader's copy cannot exceed that of the writer's copy. So the writer ought to be the person on the team with the best mental model.
Unfortunately, newer developers tend to generate the most documentation by organic processes (in the form of notes and questions based on conversations with more experienced developers). In contrast, more experienced developers tend to silently figure things out without consulting another person.
Another issue is that developers with the best mental models tend to do a good job of assimilating that information into their global "context". This assimilation can make it difficult for these experienced developers to serialize their mental models into documentation, since the boundary between "mental model" and global "context" disappears.
For example - think about how you'd explain HTTP to a random stranger who has never programmed before. It's difficult to know where to start! Beyond that, it's hard to know what mathematical background to assume, how to topologically-sort topics s.t. you never use a term before it's introduced, how to prevent confusion, and everything else that makes teaching difficult.
In conclusion, I maintain that it really takes someone knowledgeable to write documentation which is:
1. scoped to a coherent audience and purpose
2. accurate across multiple layers of abstraction
3. resistant to documentation rot (without resorting to ambiguity)
Ideally, technical documentation would be written by the most knowledgeable person available.