|
|
|
|
|
by twoquestions
3710 days ago
|
|
How do you start documenting software that you don't know well? That seems like a very good way for bad documentation to get out, damaging the project. Perhaps this is my impostor syndrome talking, but I for one would be hesitant to tempt the wrath of the Great Unseen Masters that make open source software with potentially inane questions. |
|
Read the code, try your best to understand it, and then get the documentation reviewed by someone who does know the software well. This works for code, too. Bonus points: Explicitly enlist feedback ("Anything I'm missing here? Any edge cases I forgot to note? Is my understanding of this correct?")
> I for one would be hesitant to tempt the wrath of the Great Unseen Masters that make open source software with potentially inane questions.
http://www.catb.org/esr/faqs/smart-questions.html
But if you're making an effort to contribute, that already counts for a lot. There might be some gruff redirection towards more effective means of contributing, if you're being a significant time sink and not helping that much, but hopefully that's a win/win in the end.