Putting docs into the same repo as the code might be helpful, but not all docs have corresponding code repos. I understand that getting developers to contribute to docs is not a change that happens overnight. I decided to ask the gurus on WTD Slack how they got developers to contribute edits.Įric Holscher said I need to build up a culture that cares about documentation, and then encourage developers to help.Īnne Gentle said that developers are more likely to contribute to docs when the docs co-exist in the same repos as the code. Two weeks is hardly the blink of an eye, and one can’t expect much, especially without promoting and educating users about it. (Well, except one mysterious person, who created a small PR but then closed it.)
But even after a couple of weeks, almost no one made an edit, logged an issue, or contributed any pull requests. I expected developers to immediately start logging issues, submitting pull requests, and more. It seemed I was well on my way to setting up a massive collaboration engine for documentation. The term “crowdsource” hadn’t been in my mind when putting my docs on GitHub, but I nevertheless welcomed the idea. When I announced the new Github integration to my project team, the project manager responded enthusiastically about the potential for “crowdsourcing docs.” Here’s what my docs look like with the Edit on Github button: I hoped the Github repo would enable other devs to contribute pull requests on my docs. I’d already been using an internal Git repo for the past year, so moving from internal Git to external Github posed no major technical challenges.
0 kommentar(er)
