목표
매뉴얼 작업 프로세스의 구체적인 정의
제품별 릴리즈 시점에 맞는 매뉴얼 발행
각 개발팀 / 기획팀과의 매뉴얼 작성 협의사항 정리
TW 프로젝트 QA 프로젝트에서 분리
이슈타입 정의
| 이슈타입 | 시작 | 진행 중 | 리뷰 중 | 기획팀 검토 | 완료 | 매뉴얼 적용 완료 / 하위 이슈 완료 / 결과물 작성 완료 | 비고 |
|---|
| Task | OPEN | In Progress | In Review |
| Done | Closed | 기타 작업 |
| Documentation | OPEN | In Progress | In Review |
| Resolved | Closed | 매뉴얼 작업 |
| Epic | OPEN | In Progress |
|
| Resolved | Closed | 매뉴얼 릴리즈 Epic |
| Training | OPEN | In Progress | In Review |
| Resolved | Closed | TW 교육 |
| Sub-Task | OPEN | In Progress | In Review |
| Resolved | Closed |
|
| 개발 팀 이슈 | Answer Request | TW In Progress |
| Plan In Review | Apply Manual | Closed | 각 개발팀 이슈 중 매뉴얼 적용 이슈 상태 추가 |
매뉴얼 발행 기준
제품 버저닝은 "제품명-메이저.마이너.리비전.패치" 로 발행된다
...
각 제품군의 메이저, 마이너 변경 시 매뉴얼을 릴리즈하며 버그 수정등으로 인한 UI 또는 내용의 변경이 없을 시는 매뉴얼을 발행하지 않는다.
한/영 매뉴얼 작업 순서
- 국문 매뉴얼 작업
- 국문 매뉴얼을 기준으로 영문 매뉴얼 번역
프로세스
초안작성 프로세스
작성된 매뉴얼에 대한 수정은 제품별 "Original Space" 에 Inline Comment, Page Comment 로 내용을 요청하고, "@" 로 담당자를 지정한다.
...
제품 개발 중 매뉴얼 추가에 대한 초안은 개발이슈에 디스크립션의 내용으로 개발자의 기술설명을 초안으로 한다.
매뉴얼 위키 스페이스 관리
각 매뉴얼의 위키 스페이스는 수정 요청 및 공유를 위해서 차기 버전 릴리즈 대상 위키를 "Original Space" 로 유지한다
최종적으로 수정된 위키 스페이스는 스페이스 복사로 릴리즈한다.
매뉴얼 수정 요청 프로세스
이미 작성된 매뉴얼 수정 요청은 위키에 기록한다.
...
코멘트마다 이슈를 생성하지 않고, 제품별로 이슈를 생성하여 효율성을 높인다.
각 제품 릴리즈 일정 공유
제품별 매뉴얼 릴리즈의 일정은 개별 프로젝트의 "Releases" 에 기록된 릴리즈 일정을 기준으로 한다.
릴리즈 일정이 변경될 경우에 대해서 각 프로젝트의 custom event 를 추가하여 릴리즈일정 변경 시 TW 가 알 수 있도록 하고, 이 기능이 지원되지 않을 경우 각 팀장이 TW 에게 릴리즈 일정 변경을 알린다.
매뉴얼 작업 프로세스
매뉴얼 작업이 필요한 내용은 이슈의 디스크립션에 "h3" 등의 쉽게 식별이 가능한 항목으로 TW 로 정의한다.
...
- TW 작업이 필요할 경우 개발이슈는 다음의 워크플로우를 따른다. (Open → In Progress → In Review → Dev Resolved → TW In Progress(TW작업) → Plan In Review(기획팀 검토) → Apply Manual → Closed)
- 매뉴얼에 적용될 내용은 해당 이슈에 코멘트로 작성하고 "TW In Progress" 로 상태를 변경하고 "Assignee" 를 TW 멤버로 변경하여 매뉴얼작업을 요청한다.
- TW 에서 내용이 작성완료되면 "Plan In Review" 로 상태를 변경하고 "Assignee" 를 기획팀 멤버로 변경하여 내용(기술적 내용)을 검토를 요청한다.
- 기획팀의 내용(기술적 내용) 검토가 완료되면 "Apply Manual" 로 상태를 변경하고 "Assignee" 를 TW 멤버로 변경하여 매뉴얼 작업을 요청한다.
- TW 에서 위키 페이지와 매뉴얼 소스에 적용이 완료되면 "Closed" 로 상태를 변경하여 이슈를 종결한다.
매뉴얼 이슈 관리
매뉴얼 이슈 관리는 각 제품별, 버전별, 언어, 용도별로 Epic 이슈를 작성하고 하위 작업 이슈는 Sub-Task 로 생성하지 않고 가능한 한 이슈로 작성한다.
...
제품 매뉴얼 릴리즈 로드맵은 별도의 위키페이지를 작성하여 각 개발팀과 공유하고 릴리즈 일정이 변경될 경우 TW 에서 갱신한다.
매뉴얼 로드맵 예시
| Expand |
|---|
|
| Roadmap Planner |
|---|
| maplinks | |
|---|
| timeline | true |
|---|
| pagelinks | |
|---|
| source | %7B%22title%22%3A%22Roadmap%20Planner%22%2C%22timeline%22%3A%7B%22startDate%22%3A%222018-01-01%2000%3A00%3A00%22%2C%22endDate%22%3A%222018-12-31%2000%3A00%3A00%22%2C%22displayOption%22%3A%22MONTH%22%7D%2C%22lanes%22%3A%5B%7B%22title%22%3A%22MCCS%20Enterprise%22%2C%22color%22%3A%7B%22lane%22%3A%22%23f6c342%22%2C%22bar%22%3A%22%23fadb8e%22%2C%22text%22%3A%22%23594300%22%2C%22count%22%3A1%7D%2C%22bars%22%3A%5B%7B%22title%22%3A%224.5.2%22%2C%22description%22%3A%22This%20is%20the%20first%20bar.%22%2C%22startDate%22%3A%222018-01-01%2007%3A21%3A58%22%2C%22duration%22%3A0.5148514851485149%2C%22rowIndex%22%3A0%2C%22id%22%3A%22c7769e6c-2377-4e52-8de5-cd3a68512173%22%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22title%22%3A%22Bar%202%22%2C%22description%22%3A%22This%20is%20the%20second%20bar.%22%2C%22startDate%22%3A%222017-12-01%2000%3A00%3A00%22%2C%22duration%22%3A1%2C%22rowIndex%22%3A1%2C%22id%22%3A%2201326017-425e-4ce9-ac15-317e76c7d9ef%22%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A0%2C%22startDate%22%3A%222018-01-19%2002%3A36%3A49%22%2C%22id%22%3A%2295c0e81b-402c-44fe-92d7-4d7e73636e43%22%2C%22title%22%3A%224.6%22%2C%22description%22%3A%22%22%2C%22duration%22%3A4.3861386138613865%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A0%2C%22startDate%22%3A%222018-06-02%2004%3A30%3A53%22%2C%22id%22%3A%2242be2499-baf1-4690-9241-289174149ca5%22%2C%22title%22%3A%224.7%22%2C%22description%22%3A%22%22%2C%22duration%22%3A6.930693069306931%2C%22pageLink%22%3A%7B%7D%7D%5D%7D%2C%7B%22title%22%3A%22MCCS%22%2C%22color%22%3A%7B%22lane%22%3A%22%233b7fc4%22%2C%22bar%22%3A%22%236c9fd3%22%2C%22text%22%3A%22%23ffffff%22%2C%22count%22%3A1%7D%2C%22bars%22%3A%5B%7B%22title%22%3A%224.5%22%2C%22description%22%3A%22This%20is%20the%20third%20bar.%22%2C%22startDate%22%3A%222018-01-01%2007%3A21%3A58%22%2C%22duration%22%3A5.97029702970297%2C%22rowIndex%22%3A0%2C%22id%22%3A%22f23e6991-fa49-4ffb-baa5-cacd16491028%22%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A0%2C%22startDate%22%3A%222018-07-01%2014%3A43%3A57%22%2C%22id%22%3A%229485b524-2e13-406f-bd4a-220db00dcdd9%22%2C%22title%22%3A%224.6%22%2C%22description%22%3A%22%22%2C%22duration%22%3A5.920792079207921%2C%22pageLink%22%3A%7B%7D%7D%5D%7D%2C%7B%22title%22%3A%22WDRBD%22%2C%22color%22%3A%7B%22lane%22%3A%22%23d04437%22%2C%22bar%22%3A%22%23dc7369%22%2C%22text%22%3A%22%23ffffff%22%2C%22count%22%3A1%7D%2C%22bars%22%3A%5B%7B%22rowIndex%22%3A0%2C%22startDate%22%3A%222018-01-01%2007%3A21%3A58%22%2C%22id%22%3A%22320a479d-82a9-4609-8af5-77a111ebc83e%22%2C%22title%22%3A%221.5%22%2C%22description%22%3A%22%22%2C%22duration%22%3A1%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A0%2C%22startDate%22%3A%222018-02-02%2002%3A36%3A49%22%2C%22id%22%3A%22d0a47feb-02ea-4849-a2f3-663af5973582%22%2C%22title%22%3A%221.6%22%2C%22description%22%3A%22%22%2C%22duration%22%3A1.9306930693069306%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A0%2C%22startDate%22%3A%222018-04-01%2021%3A23%3A10%22%2C%22id%22%3A%2230b77465-98fb-46f4-9e5e-22a525451884%22%2C%22title%22%3A%221.7%22%2C%22description%22%3A%22%22%2C%22duration%22%3A5.910891089108911%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A0%2C%22startDate%22%3A%222018-10-01%2022%3A05%3A56%22%2C%22id%22%3A%22fa852c7f-1000-4087-8c8c-d2a017b4a6ae%22%2C%22title%22%3A%221.8%22%2C%22description%22%3A%22%22%2C%22duration%22%3A2.9306930693069306%2C%22pageLink%22%3A%7B%7D%7D%5D%7D%2C%7B%22title%22%3A%22DRX%22%2C%22color%22%3A%7B%22lane%22%3A%22%238eb021%22%2C%22bar%22%3A%22%23aac459%22%2C%22text%22%3A%22%23ffffff%22%2C%22count%22%3A1%7D%2C%22bars%22%3A%5B%7B%22rowIndex%22%3A0%2C%22startDate%22%3A%222017-12-31%2009%3A16%3A02%22%2C%22id%22%3A%22d9616809-561a-4bf4-bbc9-d4940a14bc1d%22%2C%22title%22%3A%221.2%22%2C%22description%22%3A%22%22%2C%22duration%22%3A2.98019801980198%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A0%2C%22startDate%22%3A%222018-04-01%2007%3A07%3A43%22%2C%22id%22%3A%2281d9fb0c-6aee-464e-a0a2-86d6d22cb8f2%22%2C%22title%22%3A%222.0%22%2C%22description%22%3A%22%22%2C%22duration%22%3A8.94059405940594%2C%22pageLink%22%3A%7B%7D%7D%5D%7D%5D%2C%22markers%22%3A%5B%7B%22title%22%3A%22Marker%201%22%2C%22markerDate%22%3A%222017-12-15%2000%3A00%3A00%22%7D%2C%7B%22markerDate%22%3A%222018-01-17%2021%3A08%3A54%22%2C%22title%22%3A%22Release%22%7D%2C%7B%22markerDate%22%3A%222018-02-01%2019%3A57%3A37%22%2C%22title%22%3A%22Release%22%7D%2C%7B%22markerDate%22%3A%222018-03-31%2001%3A54%3A03%22%2C%22title%22%3A%22Release%22%7D%2C%7B%22markerDate%22%3A%222018-05-31%2016%3A38%3A01%22%2C%22title%22%3A%22Release%22%7D%2C%7B%22markerDate%22%3A%222018-07-01%2000%3A00%3A00%22%2C%22title%22%3A%22Release%22%7D%2C%7B%22markerDate%22%3A%222018-09-30%2009%3A44%3A33%22%2C%22title%22%3A%22Release%22%7D%5D%7D |
|---|
| title | Roadmap%20Planner |
|---|
| hash | e8ac8c3699c3c62baf0d64b2e45b35fe |
|---|
|
|
매뉴얼 Epic 이슈 관리 예시
| Expand |
|---|
|
| 제품 | 버전 | 언어 | 플랫폼 | 용도 | Epic 이슈 예시 | 비고 |
|---|
| MCCS | 4.5 | 국문 영문 | Windows, Linux | 설치, 사용자 | MCCS 4.6 Windows 국문 설치 안내서 MCCS 4.6 Windows 국문 사용자 안내서 MCCS 4.6 Linux 국문 설치 안내서 MCCS 4.6 Linux 국문 사용자 안내서 MCCS 4.6 Windows 영문 설치 안내서 MCCS 4.6 Windows 영문 사용자 안내서 MCCS 4.6 Linux 영문 설치 안내서 MCCS 4.6 Linux 영문 사용자 안내서 | Windows DK Windows 사용자 안내서는 MCCS 4.5 부터 작성하지 않음 MCCS DRBD Windows 사용자 안내서 → MCCS Windows 사용자 안내서로 변경 | | MDRM / Enterprise | 4.6 | 국문 영문 |
| 설치, 사용자 | MCCS Enterprise 4.6 국문 설치 안내서 MCCS Enterprise 4.6 국문 MDRM 사용자안내서 MCCS Enterprise 4.6 국문 사용자 안내서 MCCS Enterprise 4.6 영문 설치 안내서 MCCS Enterprise 4.6 영문 MDRM 사용자안내서 MCCS Enterprise 4.6 영문 사용자 안내서 | MCCS Enterprise 는 Linux Docker 이미지만 지원하므로 매뉴얼상 플랫폼 구분이 없다. | | WDRBD | 1.6 | 국문 영문 |
| 설치, 사용자 | WDRBD 1.6 국문 설치 안내서 WDRBD 1.6 국문 사용자 안내서 WDRBD 1.6 영문 설치 안내서 WDRBD 1.6 영문 사용자 안내서 | WDRBD 는 Windows 플랫폼만 지원하므로 플랫폼 매뉴얼상 구분이 없다. | | DRX | 1.1 | 국문 | Windows, Linux | 설치, 사용자 | DRX 1.1 국문 Windows 설치 안내서 DRX 1.1 국문 Windows 사용자 안내서 DRX 1.1 국문 Linux 설치 안내서 DRX 1.1 국문 Linux 사용자 안내서 DRX 1.1 영문 Windows 설치 안내서 DRX 1.1 영문 Windows 사용자 안내서 DRX 1.1 영문 Linux 설치 안내서 DRX 1.1 영문 Linux 사용자 안내서 |
|
|
...