GitHub를 중심으로 한 개발 프로세스 문서 관리

GitHub를 중심으로 한 개발 프로세스 의 문서 관리편입니다

[readme.md] 문서 관리

해당 리포지토리에 대한 문서는 GitHub에서 관리하고 GitHub에서 탐색하고 싶습니다.

왜?

공유 파일 서버에 Excel이라고 스타일은 OS의 제약이 있거나 하기 때문에 싫다

소스와 문서는 중앙에서 관리되어야한다고 생각하기 때문에

문서도 PullRequest 등으로 검토해야합니다

문서도 버전 관리하고 싶습니다

사용법

루트 디렉터리에 README.md 설치

Markdown을 써서 push한다

이 예는 doc/와 같은 디렉토리에있는 .md 파일에 대한 링크 모음으로 보았습니다.

[github wiki] Wiki 관리

관리 문서가 늘어나면 문서를 위키로 만듭니다.

특징

GitHub에서 쉽게 만들 수 있습니다

브라우저로 만든 위키는 git clone 하고 로컬에서 가필 수정할 수도 있다

페이지 목록이 마음대로 표시됩니다

사이드 바와 바닥 글도 쓸 수 있습니다

사용법

위키 탭을 선택하고 Create the first page 버튼을 누릅니다

Markdown을 쓰고 submit한다

사이드바와 바닥글은 각각 _Sidebar.md , _Footer.md 라는 Markdown을 쓰면 마음대로 표시해준다

뽀뽀하고있는 것만으로 이런 느낌의 Wiki를 할 수 버린다


이 예도 readme의 예와 같이 링크집으로 본 사이드바가 인덱스가 되어 있다

readme과 wiki의 차이

가장 다른 것은 README.md는 동일한 리포지토리이지만, Wiki는 다른 리포지토리라는 점이라고 생각한다
둘 다 관리한다면,



README.md
Wiki


업데이트 빈도
자주
거의 없음

PullRequest에
포함하고 싶다
포함하지 않아도 좋다.

관리자
개발자
예를 들어 PO나 디렉터

내용
개발자용
시스템 사용자용

원한다면 다른 기사도주세요.

모쿠지

공개

자동화

과제 관리

ZenHub

만족하지 못하는 것