docs 리포지토리 관리 방법 - dev-graft/syuck-syuck-docs GitHub Wiki
docs 리포지토리 설명
docs는 프로젝트 진행에 필요한 문서를 관리하는 리포지토리입니다.
- 프로젝트 기간동안 정해진 정보를 정확하게 공유하여 프로젝트 진행에 차질이 없게 합니다.
- 프로젝트를 진행 및 마무리하며 생긴 문서들을 간단한 정리로도 블로그, 포트폴리오 등에 활용가능하도록 작성하는 것이 목적입니다.
관리할 범위는 크게 두 가지 입니다.
| 이름 | 설명 |
|---|---|
| Issues | Act를 어떻게 진행하고 각 platform에게 무엇을 할당할지 작성합니다.기술적인 작업목록은 작성하지 않습니다. |
| Wiki | 기획서, 스토리보드, 회의록 기록 등 프로젝트의 포괄적인 내용을 작성합니다.무엇을 개발 중이고 어떠한 것을 고려했는지 꼭 작성해주세요! |
docs 리포지토리 추가하기
1. 리포지토리 생성하기
2. wiki 첫 페이지 추가하기
3. wiki 클론하기
다음 명령어를 터미널에 순서대로 입력 (git 명령어가 가능하다는 전제)
git clone https://github.com/dev-graft/{service-name}.wiki.git
git clone https://github.com/dev-graft/.github.wiki.git
mv .github.wiki/** {service-name}.wiki
cd {service-name}.wiki
git add *
git commit -m "Update"
git push
완료할 경우 wiki가 수정되었음을 확인할 수 있습니다!
wiki 설명
wiki의 사이드 탭을 보면 3가지 내용을 확인할 수 있습니다.
| 이름 | 설명 |
|---|---|
| 팀 공지사항 | 팀의 필수적인 규칙 및 정보가 작성된 페이지입니다.관리할 필요가 없고, 해당 링크를 클릭할 경우 dev-graft의 공지사항으로 이동하게됩니다. |
| 기획 문서 | 프로젝트를 진행함에 있어 가장 중요한 기획서, 스토리보드, UML를 관리하는 페이지입니다.각 문서에 알맞는 내용을 작성하고, 스토리보드는 .wiki문서를 직접 수정하여 외부의 디자인 링크로 수정이 필요합니다. |
| 기록 | 프로젝트를 진행하며 진행된 회의록, 데일리 이슈, 업데이트 등을 관리하는 페이지입니다.팀 공지사항의 템플릿에서 기록에 맞는 템플릿을 찾을 수 있습니다. |