목표

매뉴얼 작업 프로세스의 구체적인 정의

제품별 릴리즈 시점에 맞는 매뉴얼 발행

각 개발팀 / 기획팀과의 매뉴얼 작성 협의사항 정리

TW 프로젝트 QA 프로젝트에서 분리

이슈타입 정의

매뉴얼 발행 기준

제품 버저닝은 "제품명-메이저.마이너.리비전.패치" 로 발행된다

(예: MCCS Enterprise 4.5.2 / 메이저 : 4 , 마이너 : 5 , 리비전 : 2)

각 제품군의 메이저, 마이너 변경 시 매뉴얼을 릴리즈하며 버그 수정등으로 인한 UI 또는 내용의 변경이 없을 시는 매뉴얼을 발행하지 않는다.

한/영 매뉴얼 작업 순서

1. 국문 매뉴얼 작업
2. 국문 매뉴얼을 기준으로 영문 매뉴얼 번역

프로세스

초안작성 프로세스

작성된 매뉴얼에 대한 수정은 제품별 "Original Space" 에 Inline Comment, Page Comment 로 내용을 요청하고, "@" 로 담당자를 지정한다.

제품 개발 중 매뉴얼 추가에 대한 초안은 개발이슈에 디스크립션의 내용으로 개발자의 기술설명을 초안으로 한다.

매뉴얼 위키 스페이스 관리

각 매뉴얼의 위키 스페이스는 수정 요청 및 공유를 위해서 차기 버전 릴리즈 대상 위키를 "Original Space" 로 유지한다

최종적으로 수정된 위키 스페이스는 스페이스 복사로 릴리즈한다.

매뉴얼 수정 요청 프로세스

이미 작성된 매뉴얼 수정 요청은 위키에 기록한다.

해당 내용의 직접 수정일 경우 "Inline Comment" 로 "@"으로 기록하여 TW 로 매뉴얼 수정을 요청하고 전반적인 내용일 경우 최하단 코멘트에 "@"으로 기록하여 매뉴얼 수정을 요청한다.

위키 페이지에 기록된 내용은 매일 내용을 확인 및 수정하고 업데이트 된 내용은 이슈로 생성 후 매주 목요일 오전까지 처리한다.

코멘트마다 이슈를 생성하지 않고, 제품별로 이슈를 생성하여 효율성을 높인다.

각 제품 릴리즈 일정 공유

제품별 매뉴얼 릴리즈의 일정은 개별 프로젝트의 "Releases" 에 기록된 릴리즈 일정을 기준으로 한다.

릴리즈 일정이 변경될 경우에 대해서 각 프로젝트의 custom event 를 추가하여 릴리즈일정 변경 시 TW 가 알 수 있도록 하고, 이 기능이 지원되지 않을 경우 각 팀장이 TW 에게 릴리즈 일정 변경을 알린다.

매뉴얼 작업 프로세스

매뉴얼 작업이 필요한 내용은 이슈의 디스크립션에 "h3" 등의 쉽게 식별이 가능한 항목으로 TW 로 정의한다.

내용에 대한 구체적인 설명을 디스크립션에 기록하고 스크린 샷일 경우 스크린샷을 개발이슈에 첨부한다.

1. TW 작업이 필요할 경우 개발이슈는 다음의 워크플로우를 따른다. (Open → In Progress → In Review → Dev Resolved → TW In Progress(TW작업) → Plan In Review(기획팀 검토) → Apply Manual → Closed)
2. 매뉴얼에 적용될 내용은 해당 이슈에 코멘트로 작성하고 "TW In Progress" 로 상태를 변경하고 "Assignee" 를 TW 멤버로 변경하여 매뉴얼작업을 요청한다.
3. TW 에서 내용이 작성완료되면 "Plan In Review" 로 상태를 변경하고 "Assignee" 를 기획팀 멤버로 변경하여 내용(기술적 내용)을 검토를 요청한다.
4. 기획팀의 내용(기술적 내용) 검토가 완료되면 "Apply Manual" 로 상태를 변경하고 "Assignee" 를 TW 멤버로 변경하여 매뉴얼 작업을 요청한다.
5. TW 에서 위키 페이지와 매뉴얼 소스에 적용이 완료되면 "Closed" 로 상태를 변경하여 이슈를 종결한다.

매뉴얼 이슈 관리

매뉴얼 이슈 관리는 각 제품별, 버전별, 언어, 용도별로 Epic 이슈를 작성하고 하위 작업 이슈는 Sub-Task 로 생성하지 않고 가능한 한 이슈로 작성한다.

각 Epic 이슈는 각 제품의 릴리즈 시점에 맞게 로드맵 뷰 또는 표로 일정을 기록한다.

제품 매뉴얼 릴리즈 로드맵은 별도의 위키페이지를 작성하여 각 개발팀과 공유하고 릴리즈 일정이 변경될 경우 TW 에서 갱신한다.

매뉴얼 로드맵 예시

매뉴얼 Epic 이슈 관리 예시