매뉴얼 관리

Owned by 유재형
Last updated: 2019/07/26
2 min read

JIRA 이슈 관리


이슈 타입설명
제품 버전 별로 Epic 이슈를 생성한다.
(예시: MCCS 4.4.6, MCCS Enterprise 4.5.4)

Epic 하위의 문서 작업을 Documentation으로 생성한다.

예시

  • 저작권 페이지 작성
  • 문장 수정
  • 용어 표준화 작성
  • 영문으로 번역
  • 설치 요구사항 작성

혹은

  • MCCS 4.4.6 Windows_kor
  • MCCS 4.4.6 Windows_eng
  • MCCS 4.4.6 Linux_kor
  • MCCS 4.4.6 Linux_eng


라벨설명생성자

매뉴얼 관련 이슈 라벨 사용TW


개발자가 생성한 이슈 중 매뉴얼에 필요한 내용이라 판단될 때 라벨 사용개발자




매뉴얼 구성

주요 사항

  • 설치 매뉴얼과 사용 매뉴얼을 구분할 것인가?
    → 현재는 한 매뉴얼 안에서 부로 구분되어 있으나 라이선스 문제가 아니면 별도의 매뉴얼로 분리하는 것도 좋을 듯.
  • 라이브러리를 사용할 것인가?
    → 사용한다.
  • 릴리즈 노트 제공 방식은?
    → 현재 wiki의 페이지를 링크하여 제공하지만 3rabbitz 문서로 관리되면 더 좋을듯.

라이브러리 사용 시

  • 매뉴얼
    • 버전별 매뉴얼
  • 설치 가이드
  • 릴리즈 노트
  • FAQ 

※ 참고 매뉴얼(투비 소프트) - http://docs.tobesoft.com/product_information_nexacro_17_ko
※ 참고 매뉴얼(3Rabbitz) - https://www.3rabbitz.com/book_user_guide_3_0_ko

라이브러리 미사용 시

  • 설치 + 사용 매뉴얼

※ 참고 매뉴얼(제니퍼 소프트) - https://docs.jennifersoft.com/4.5manual#


배포 관리

선택안

  1. 기존 위키 페이지로 배포했던 방식과 동일하게 링크
    : HTML 파일들을 별도 관리

  2. 회사 홈페이지에 링크 화면
    : HTML 파일들을 별도 관리, 쉽게 접근 가능하여 보안 취약

  3. 문서 제공을 위한 별도의 웹페이지로 제공
    : 3rabbitz에서 간략히 기능을 제공함.(추가적인 html 작업 필요)


 관련 회의록

2019/3/28

+ 회의 주제: 매뉴얼 배포 관리에 대한 방향과 3Rabbitz 라이선스에 대하여...

+ 참석자: 원효수CJ, 임헌규CJ, 정은진DL, 유재형DL

  • 아직 상위 라이선스를 요청할 시기가 아니다.
    → 일단 국/영문에 대한 매뉴얼이 어느 정도 진행되거나 3팀 매뉴얼이 3Rabbitz으로 전환되어 최대 권수(20권)에 임박할 때 상위 라이선스로 갱신하는 방향을 제안한다.(매뉴얼 유형 카운트 - 매뉴얼 관리.xlsx)
  • 라이선스를 업그레이드할 시점에 사내 문서 관리 정책에 대해 논의해보고 어떤 라이선스를 구매할지 결정한다.


  • 현재 매뉴얼을 포함한 문서 관리의 체계성이 많이 부족해서 필요한 자료에 대한 접근성이 매우 떨어진다.
    → 사내 홈페이지 또는 별도의 고객센터 홈페이지와 같은 웹페이지를 통해서 좀 더 일관성 있고 체계적으로 문서를 배포하면 좋겠다.
  • 일단 MCCS Enterprise/MDRM은 제품 스펙 공유에 대한 보안을 고려하여 비공개로 제공한다.

제품 관리

프로젝트 관리

  • 개발팀별로 프로젝트를 1차 구분
  • 팀 내에서 제품 별로 2차 구분


참고