잘 문서화 된 소프트웨어 개발은 성공으로 이어진다는 것을 모두 알고 있습니다. 그러나 일반적으로 UML 다이어그램과 같이 일반 텍스트뿐만 아니라 이진 컨텐츠도 문서에 포함됩니다. 그리고 많은 사람들이 그렇게 말하는 것을 들었습니다. 버전 제어 시스템이 이진 파일에 적합한 장소가 아닙니다. 이 문제를 완전히 이해하고 동의합니다. 나는 여러 노련한 개발자들에게 문서를 저장하기에 가장 좋은 곳이 어디인지 물어 보았고 그 대답은 "wiki"였습니다. 위키는 좋지만 다른 잠재적 인 문제를 고려했습니다. 버전 관리 시스템에 저장된 소스 코드를 어떻게 위키에서 관련 문서에 연결할 수 있습니까? 누군가 git 또는 mercurial의 저장소를 복제한다고 가정 해 봅시다. 문서를 쉽게 찾을 수있는 방법은 무엇입니까? 아니면 방금 뭔가를 놓쳤습니까?
일부 위키 시스템에는 소스 제어 시스템과 통합 할 수있는 기능이 있습니다. 그러나 저의 관심사는 통합 능력에 관한 것이 아닙니다. git 저장소에서 소스 코드를 복제하고 잠시 후에 기차를 타고 기차에서 오프라인으로 계속 작업하려는 경우 (DVCS의 큰 기능). 그런 다음 기차에서 오프라인으로 작업하기 때문에 문서에 액세스 할 수 없다는 것을 갑자기 알게됩니다. 반면에 문서가 자식 저장소에 저장된 경우 저장소가 복제 된 문서에 액세스 할 수 있습니다.
3
참고 : 위키는 약어 가 아니며 , "빠른"을 의미하는 하와이 단어입니다.
—
Jörg W Mittag
문서에 바이너리가 포함되어 있다는 사실이 실제로 버전 관리 시스템에 문서를 저장하지 않는 좋은 이유는 아닙니다. VCS는 이진 파일을 쉽게 처리 할 수 있습니다. 프로젝트의 VCS에 저장하면 프로젝트를 분기 할 때 문서를 분기 할 수 있다는 이점이 있습니다.
—
JW01
오프라인 작업과 관련하여 : 무차별 대입 솔루션은 일부 오프라인 리더기를 사용하여 원하는 페이지를 다운로드하는 것입니다. 더 우아한 방법은 실제 위키 전체를 복제하는 것입니다 (예 : 기본 데이터베이스를 복사하고 위키를 직접 설치). VCS 기반 위키는 훨씬 더 우아한 솔루션입니다. 나는 종종 오프라인에서 일하며 보통 정기적으로 필요한 페이지를 다운로드하는 것으로 충분합니다.
—
sleske