Совместное кодирование и документация

Question

На новой исследовательской работе я буду частью долгосрочных усилий по очистке довольно обширной базы Java-кода (более 7 лет разработки).В настоящее время он находится в SVN, но я рассматриваю Mercurial.

Возможно, есть два типа людей, сотрудничающих над проектом.Тип 1: люди, которые будут разрабатывать много кода и писать документацию.Тип 2: люди, которые являются пользователями кода и имеют очень хорошие предложения по документации и удобству использования.

Я представляю себе такой рабочий процесс:

1. Разработчик просматривает раздел кода и(пере) пишет документацию (в кодировке Javadoc / Doxygen style)
2. Код подтверждения разработчика
3. Обновление сервера версий HTML-документация
4. Пользователи типа 2 могут просматривать документацию и оставлять комментариина самой странице документации (стиль вики?).Соавторы могут обсудить это здесь.
5. Разработчики просматривают комментарии и переходят к шагу 1.

Я ищу любые предложения о предлагаемом рабочем процессе и идеи об инструментах, которые помогутвыполнить это.Спасибо!

Answer 1

Я предлагаю вам сделать людей типа 2 (клиентов?) частью команды напрямую, чтобы они могли сразу помочь разработчикам, вместо того, чтобы писать документы.

Это должно сделать это намного быстрее, так как это увеличивает связь и значительно сокращает цикл обратной связи.

Answer 2

Я настоятельно рекомендую список рассылки о коммитах: благодаря тому, что изменения были легко видны всем, поскольку они произошли, наш обзор кода был значительно лучше: ошибки были обнаружены ранее, были сделаны предложения, пока код был еще свежим в уме разработчика, и все чувствовали, что все в команде работают лучше.