GitHub 프로젝트에 대한 문서를 작성하고 어디에 써야하는지 궁금합니다. README.md와 비슷한 저장소 (예 : docs/디렉토리)에있는 GitHub Pages, GitHub Wiki 또는 Markdown 파일 세트의 세 가지 옵션이있는 것으로 보입니다. 이해할 수 있지만 여러 장소에 동일한 문서를 작성하고 싶지 않으므로 선택해야합니다.GitHub의 문서 옵션
그래서 옵션 간의 차이, 장단점은 무엇입니까? 특히 프로젝트 문서화에 대한 경험이나 생각? 또한 세 가지 외에 다른 옵션이 있습니까?
저는 개인적으로 변경 빈도 및 기여자 수를 결정하는 아주 좋은 질문입니다.
예 : 프로젝트 (C++ 라이브러리) 중 하나에서 doxygen과 함께 (예 : 마스터 릴리스 분기를 업데이트하는 동안) 한 번씩 HTML 문서를 만듭니다. 이것은 준 정적 (quasi-static) gh-pages에 대한 완벽한 일치입니다. 또한 그것에 대한 하위 도메인을 얻을 http://<user>.github.io/<project>/ 그리고 당신은 그것의 위에 자신의 도메인을 등록 할 수 있습니다.
다른 프로젝트에는 개발자 및 사용자 문서 (C++ 프로그램)가 포함되어 있습니다. 나는 개인적으로 을 선호하여 개발자를위한 기본 워크 플로우를 제공한다..md 파일은 메인 라인 개발과 일관성을 유지한다. 변경 사항은 먼저 끌어 오기 요청에 의해 검토됩니다.
그러나 사용자 문서을 위해 우리가 선택한 위키 빌드 -가 편집하고 수정하기가 매우 용이하기 때문에 - 하나에도 팀의 비회원으로 수정을 허용 할 수 있습니다.