공동 작성 및 문서

Question

새로운 연구 작업에서 나는 꽤 광범위한 Java 코드베이스 (7 년 이상의 개발 기간)를 정리하기위한 장기적인 노력의 일환으로 일할 것입니다. 현재 SVN에 있지만 Mercurial을 고려하고 있습니다.

아마도 두 가지 유형의 사람들이 프로젝트에서 공동 작업을합니다. 타입 1 : 많은 코드를 개발하고 문서를 작성하는 사람들. 유형 2 : 코드 사용자로서 문서화와 유용성에 대한 좋은 제안을합니다.

1. 는 개발자가 코드의 섹션을 검토하고 (다시는) (에 코드의 Javadoc/Doxygen을 스타일)
2. 개발자가 코드를
3. 버전 서버를 저지른 문서를 작성 :

   나는 워크 플로우과 같이 상상 HTML 문서 업데이트

4. 유형 2 사용자는 설명서를 검토하고 설명서 페이지 자체에 대한 의견을 제출할 수 있습니다 (위키 스타일?). 공동 작업자는 여기에서 토론 할 수 있습니다.
5. 개발자는 댓글을보고 나는 그것을 수행하는 데 도움이됩니다 도구에 대한 제안 된 워크 플로우 및 아이디어에 대한 제안을 찾고 있는데요 1.

단계로 이동합니다. 감사!

Answer 1

메일 목록을 작성하는 것이 좋습니다. 변경 사항을 모든 사람이 쉽게 볼 수 있도록함으로써 코드 검토가 훨씬 빨라졌습니다. 이전에 오류가 발견되어 개발자의 마음에 새로운 코드가있는 동안 제안되었습니다. , 그리고 모두는 팀의 다른 모든 사람들이 작업하고있는 것을 더 잘 알고있었습니다.

Answer 2

유형 2 (고객?) 사람들 을 팀에 직접 제출하여 개발자가 문서를 작성하는 대신 바로 도움을받을 수 있도록하는 것이 좋습니다.

이렇게하면 통신 속도가 빨라지고 피드백 루프가 크게 단축되므로이 속도가 훨씬 빨라집니다.