문서화_관련_안내 - boostcampwm-2024/and04-Nature-Album GitHub Wiki

✅ 문서화 관련 안내

노션에서 새 문서 생성 시 템플릿 중 해당하는 것으로 생성해주세요. 기본 설정 및 가이드라인이 작성 되어 있습니다. 하위 내용은 적절하게 수정하여 활용합니다.

아래는 문서화를 효율적으로 관리하기 위한 상태 옵션과 속성 가이드입니다. 각 문서 작성 시 이 속성들을 포함하여 상태에 맞는 작업을 진행해 주세요. 또한, 완료된 문서가 Wiki에 등록되거나 PR로 사용되는 경우 해당 URL도 함께 기재해 주시기 바랍니다.

비공개: Wiki에 올리지 않을 문서입니다. 내부 참고용으로만 사용하며, 팀과 공유할 필요가 없는 자료를 기록하는 상태입니다.
시작 전: 문서화가 필요하다고 판단되었지만, 아직 본격적인 작성에 착수하지 않은 상태입니다. 주로 문서의 틀을 잡거나 아이디어만 간단히 메모한 상태입니다.
진행 중: 문서 작성이 진행 중인 단계입니다. 문서의 기획, 초안 작성, 검토 과정이 이 단계에 포함되며, 문서를 작성하고 수정하는 작업이 진행 중일 때 사용합니다.
수정 필요: 이미 Wiki에 등록된 문서에서 오류나 잘못된 정보가 발견되어 수정이 필요한 상태입니다. 오타, 잘못된 링크, 부정확한 정보 등 문서의 품질을 보완하기 위한 작업이 필요한 경우 사용합니다.
업데이트 필요: Wiki에 등록된 문서에 새로운 정보가 추가되거나 정책 변경이 발생해 내용 확장이 필요한 상태입니다. 프로젝트 진행 중 추가적인 정보나 기능이 반영되어야 할 때 사용합니다.
wiki 등록 완료: 모든 작업이 완료되어 최종적으로 Wiki에 등록된 상태입니다. 수정이나 업데이트가 필요하지 않은 완성된 문서입니다.

각 문서의 상태와 함께 아래의 속성을 반드시 기록해 주세요:

날짜: 문서화 시작일 또는 완료일을 기록합니다.
담당자: 참여한 팀원들의 이름을 모두 기재합니다.
키워드: 문서와 관련된 주요 키워드를 설정하여, 문서를 빠르게 찾을 수 있도록 합니다. 또한, 키워드로 문서의 내용을 쉽게 파악할 수 있도록 합니다.
문서 분류: 문서의 유형을 구분하여 관리합니다. 예를 들어, "기술 문서", "트러블 슈팅", "프로세스 가이드" 등으로 분류합니다.
문서화: 문서의 작성 및 진행 상태를 명시합니다. 위에서 설명한 상태 옵션에 맞춰 "비공개", "시작 전", "진행 중", "수정 필요", "업데이트 필요", "wiki 등록 완료" 중 하나로 설정합니다.
문서화 URL: 문서화가 완료되어 Wiki에 등록되거나 PR로 사용된 경우, 해당 URL을 추가해 줍니다. 이를 통해 문서에 접근하기 쉽게 관리할 수 있습니다.

진행 중 상태인 경우
- 날짜: 2024-11-18
- 담당자: 정유진
- 키워드: Compose, UI/UX
- 문서 분류: 트러블 슈팅
- 문서화: 진행 중
- 문서화 URL: (등록 후 URL 추가)
wiki 등록 완료 상태인 경우
- 날짜: 2024-11-18
- 담당자: 정유진
- 키워드: Naver Maps Setting
- 문서 분류: 개발 문서
- 문서화: wiki 등록 완료
- 문서화 URL: (문서화 업로드한 곳 URL 추가)