2017-12-19 매뉴얼 업무 프로세스 회의록

Owned by 박현석
Last updated: 2021/01/21
2 min read

Date

Attendees

Goals

  • 매뉴얼 프로세스 구체화

Discussion items

TW 프로젝트 생성

TW Project

매뉴얼 발행 기준

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

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

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

매뉴얼 내용 공유

각 제품군의 발행 전 매뉴얼은 "위키" 로 공유한다.

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

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

제품 릴리즈 시점에 대한 공유

각 프로젝트는 알파버전 및 정식버전에 대한 릴리즈 일정을 표기하여 TW 와 공유한다.

각 프로젝트가 릴리즈 알림 및 날짜 변경에 대한 e-mail 알림이 발송되지 않기 때문에 TW 에서는 제품의 릴리즈 시점이 되면 주기적으로 각 개발팀장에게 확인하여 발행 릴리즈를 공유한다.

새로운 매뉴얼 추가 내용에 대한 프로세스

매뉴얼에 기록되어야 하는 이슈에 대해서 각 개발담당자는 이슈에 "라벨" 을 "TW" 로 추가한다.

"라벨" 이 추가된 이슈에 대해서 개발담당자는 해당 내용을 TW 프로젝트에 이슈로 생성하고 개발이슈와 TW 이슈를 링크로 연결한다.

TW 이슈에 개발담당자는 다음의 형식으로 내용을 기입한다.

TW-1 - Getting issue details... STATUS

TW 이슈는 In Review 단계에서 기술 내용을 검토할 각 개발 담당자에게 "@" 로 알리고 각 개발 담당자는 내용에 대해서 기술검토를 해야 하며, 각 개발 팀장은 이 내용을 확인한다.

개발이슈와 TW 매뉴얼 이슈는 별개로 진행되며, 이미 Resolved 된 개발 이슈가 다시 Re-Open 되어 매뉴얼이 추가로 수정되어야 하는 경우, TW 담당자에게 "@" 로 다시 알린다.

기존 발행된 매뉴얼에 대한 수정 프로세스

기존 발행된 매뉴얼의 수정 요청의 기준은 위키 스페이스이며, 이 스페이스는 "Original Space" 로 명명한다. (예 : MCCS Windows 한글 Original Space )

간단한 내용은 Inline Comment 로 요청하고, 코멘트에 "@" 로 TW 담당자를 지정한다.

TW 담당자는 Inline Comment 를 수정한 후 각 개발팀장에게 기술내용검토를 "@" 로 요청한다.

각 개발팀장은 기술내용 검토가 완료된 Inline Comment 에 "@" 로 TW 담당자에게 검토 완료를 알린다.

검토가 완료된 내용은 즉시 매뉴얼소스 (현재는 워드)에 적용하여 위키와 매뉴얼 소스의 내용을 일치시킨다.

매뉴얼 프로세스 플로우

이슈관리 정책

매뉴얼 버전발행에 대한 작업 단위는 "Epic" 으로 정의한다.

해당 버전 발행 시 생성되는 이슈는 sub-task 로 생성하지 ��는다.

이슈의 단위는 가능한한 주 단위를 넘기지 않는 작업 단위로 생성하며, 진행상황을 기록한다.

TW 스페이스의 메인 페이지에 에 각 개발팀의 제품군 릴리즈 로드맵을 지정하고, 릴리즈 일시가 변경에 대해서 추적/업데이트 한다.

Action items