온라인 메뉴얼, Technical Support

온라인 메뉴얼, Technical Support 문서 퍼블리싱 하기

온라인 메뉴얼과 Technical Support 문서는 당사의 고객에게 노출되는 문서로, 동료검토(Submit for review)를 통해 최종 검수 완료 후 기획팀의 담당자가 최종 퍼블리싱(Merge) 합니다. ( 보다 자세한 Gitbook의 동작방식에 대해서는 'Change request'(=Edit)를 이용해 협업하기를 참고하시길 바랍니다. )

1. Space 우측 상단의 'Edit' 버튼을 클릭하여 문서 작성을 시작합니다.

검토 요청(Submit for review)을 하기 전 작성에 시간이 소요되는 경우 'Draft' 버전을 이용하여 지속적인 업데이트를 진행 하시길 바랍니다.

2. 편집 중인 'Draft' 버전을 찾기 쉽도록 현재 편집 중인 'Draft' 버전에 대한 설명을 추가 합니다.

• 편집 중인 창을 닫거나, 다른 페이지로 이동하여 현재 버전을 찾기 어려울 때 Draft 버전을 이용한 문서관리를 참고 하시어, 이전에 편집중인 버전으로 복귀하시길 바랍니다.

• 편집을 수행하면서 우측 상단의 'Preview' 버튼을 클릭하여, 퍼블리싱된 모습을 확인하실 수 있습니다.

3. 편집중인 문서 작성을 완료한 후, 검토 요청을 위해 우측 상단의 'Submit for review'를 클릭합니다.

'Submit for Review'를 클릭시, 해당 스페이스의 멤버에게 검토 요청을 위한 email이 자동 발송됩니다.

• Submit for review 클릭 시, Submit에 대한 정보를 작성하는 창이 뜨며 아래의 사항을 입력하시길 바랍니다.

• 'Subject' 란에 간단하게 주요 업데이트 내용을 적어 줍니다.

  • 예) '문서 퍼블리싱 프로세스 페이지 추가', '문서의 버전관리 페이지 업데이트' 등.

• 'Note' 란에 review 요청에 대한 세부내용과 @doc 를 추가 합니다. 특히, review요청에 대한 알림을 위해 @doc 는 반드시 추가해주시길 바랍니다.

  • 예) 문서 퍼블리싱 프로세스를 신규추가하고, 문서의 버전관리 페이지에 오류를 수정에 대한 검토를 요청. @doc

4. 최종 검수 완료 후, 기획팀의 담당자가 최종 'Merge'를 수행하며, Merge와 동시에 웹에 퍼블리싱 완료 됩니다.

5. 검토자가 추가 수정 요구사항을 요청할 경우 문서의 상태는 'Draft' 상태로 변환되며, 검토 요청사항에 대한 'comment' 가 자동메일 발송됩니다. 문서 작성자는 메일의 링크를 통해 해당 'comment'에 대한 검토 완료후 위 2번 과정을 통해 검토를 재 요청 합니다.

In Review 상태 문서를 재 수정하기

'Submit for review'를 클릭하면, 문서의 상태는 'Draft' 에서 'In Review' 상태로 전환되며, 해당버전을 다시 재 편집하기를 원할 경우 'In Review' 패널에서 찾아서 편집을 계속할 수 있습니다. 'In Review' 상태의 문서를 재 편집하기 위해서는 아래의 절차를 따라 'Change Reqeusts'의 'In Review' 패널에서 해당버전을 찾아 편집하시길 바랍니다.

1. 해당 Space의 우측 상단의 'Change Request'를 클릭합니다.

2. 오른쪽에 나타난 슬라이딩 창에서 'In Review' 탭을 클릭합니다.

3. 검토 요청 후 리뷰중인 문서를 클릭합니다.

4. 해당 문서를 계속해서 편집하실 수 있습니다.