Loomio

Let's start a team for documenting EXISTING code.

T tortoise Public Seen by 20
JH

Jonne Haß Tue 11 Sep 2012 9:45PM

Simple answer? No. In a conversation I can adjust the level of explanation to the skills of the other party, we can find out things together (you seem to assume I've got absolute knowledge about every single piece of code in Diaspora, while I'm just good with reading it and with Google). In arbitrary writings about the codebase I would need to make (wrong) assumptions about the reader. I certainly will create/contribute to an FAQ if the same questions come up again and again.

You can't compare a FOSS project with contract work, in a FOSS project your chance that you can reach the original author of a piece of code or at least someone understanding it, is by far greater, while in contract work that might not be the case from what I've heard.

A

altruism Tue 11 Sep 2012 9:46PM

md, if you count groovehunter as a team yes :)

T

tortoise Tue 11 Sep 2012 9:53PM

@Jonne: Sorry, I did not mean to sound like a there is one single solution. I'm just bringing up something I've heard discussed and what might be helpful to speak to those folks (who may be reading this in the near future).

I thought that documentation of code is to let people who use the code what it does and how to modify it. I heard this is missing. Especially in regard to federation. What do I know? If I'm wrong I'm wrong. I'm not afraid to be wrong! :)

I also do not mean to represent how FOSS should work, either. I'm just thinking out loud and asking questions.

I'm certainly grateful to learn more about it. So, thanks!