3 ms·
I contribute to the documentation [1] for the Fluentd oss project [2]. I'm not sure how general my situation is, but in my case, a few friends were starting a
by hkmurakami 14y ago
I contribute to the documentation [1] for the Fluentd oss project [2].
I'm not sure how general my situation is, but in my case, a few friends were starting a company [3] and they had open sourced their log collector. Their initial team didn't have the writing skills / bandwidth to maintain great documentation [4], so they looked in their circle of friends to find a few people (including myself) with strong writing skills and a decent technical background (I work full time elsewhere).
The current workflow has developers writing the core / original documentation, which is then edited by more writing-centric people like myself (I edit heavily!).
One thing that might help, is to add the writer-friend as a committer to the project, even though he only writes documentation (this is the case for me). I think it helps with the obvious motivation issues, and also sends a message to the project at large that the project leadership deems documentation to be just as (or nearly as) important as the code itself!
[1] https://github.com/fluent/fluentd-docs https://github.com/fluent/fluentd-docs
[2] http://fluentd.org/ http://fluentd.org/
[3] http://www.treasure-data.com/ http://www.treasure-data.com/
[4] The CEO used to work for RedHat, which apparently treats documentation as a vital piece of their product. I remember him saying, "the documentation really is the face of a technical company".