2 ms·
> An organization’s developers need to write the docs, obviously. The developers need to be involved in writing the docs, but they don't really need to be the
by toast0 6y ago
> An organization’s developers need to write the docs, obviously.
The developers need to be involved in writing the docs, but they don't really need to be the ones writing them. Often, it's better if the community that will be reading the docs writes them, so it has the information they'll be looking for (somewhat addressed by a template). Or, a technical writer can write the documentation (with input from the people who are likely to read it as well as the people who have the knowledge, of course), which often results in nice documentation.
As mentioned, a feedback loop and editing documents as they are used is very important. Cataloging interventions and working to reduce them is also important. Sometimes it's the right thing to keep things manual with intervention from the runbook; there are many things where it's easy for a human to determine the scope of an issue and take the appropriate action, but hard to automate. But frequent interventions should be automated away if possible.