Hire a technical writer.
Not only for your external documentation... for all of it.
If you are afraid of the costs, do the math.
1 technical writer for every 20 developers.
Not only for your external documentation... for all of it.
If you are afraid of the costs, do the math.
1 technical writer for every 20 developers.
They can help identify gaps in documentation, outdated documentation, etc. They can take care of the clarity, formatting and distribution. You can create a ticket about documentation and assign it to them.
Then, while many developers write excellent documentation... some other developers truly SUCK at documenting. Some people like to sound intelligent and their comments read like a choose-your-adventure monologue that cannot be read linearly. Or they use vague, ambiguous language, or overuse acronyms or abbreviations. Or they sign every piece of code they touch like a dog scent marking your entire code base. Or they use profanity, or they get offtopic or humorous... All of that is a distraction from doing my job.
The technical writer takes care of those problems for you. They can create guidelines for documentation so that people treat documentation with the respect it deserves.
> All of that is a distraction from doing my job.
What job would that be? Do you actually have one?
For privacy reasons as this is indexed in search engines and comments cannot be deleted after 1 hour, forever.
> What job would that be? Do you actually have one?
I do, and it's none of your business.
If you want to participate in a community with an expectation of real life identity go have your discussions on Facebook or whatever.
Is technical writing part of your interviews? do you hire, promote or fire people based on technical writing performance? Is documentation taken as seriously as other code deliverables?
Why paying an expensive senior developer to maintain documentation in a non-commited way when you can pay a technical writer to do it better and for cheaper than the engineer can? And with real ownership and accountability over documentation, unlike the engineers.
Technical writers are cost efficient and pay themselves very quickly.