📗
Gitbook 사용법
Gitbook 사용법KnowledgeBase
  • Quick Start
    • Quick Start Guide
  • 게재하기
    • 처음 로그인 하기
      • 팀 공용계정으로 로그인 하기
    • on-Doc의 구성
    • 문서 퍼블리싱 하기
      • 온라인 메뉴얼, Technical Support
      • Knowledge Base
    • 협업하여 문서 작성하기
  • 새로 작성하기
    • 새 페이지 & 서브 페이지 만들기
    • Import로 작성(word,docs ..etc)
    • Gitbook Editor 기능
  • 수정하기
    • 글 수정하고 퍼블리싱하기
    • Group만들기
    • 그룹 하위로 글 옮기기
  • FAQ
    • FAQs
    • Gitbook 한글 타이핑 버그
  • Gitbook 공식 사용 매뉴얼
Powered by GitBook
On this page
  • 1. Knowledge Base 문서 퍼블리싱 하기
  • 2. 작성자에게 문의나 수정을 요청할 경우
  • 3. 작성내용을 추가하여, 원 저작자에게 검토를 요청할 경우
  • 4. Merge 시 충돌(Conflicts)이 날 경우

Was this helpful?

  1. 게재하기
  2. 문서 퍼블리싱 하기

Knowledge Base

Previous온라인 메뉴얼, Technical SupportNext협업하여 문서 작성하기

Last updated 1 year ago

Was this helpful?

1. Knowledge Base 문서 퍼블리싱 하기

Knowledge Base는 회사내 지식공유를 통해 구성원들 간 지식의 눈높이를 맞추고, 업무효율을 향상시키는데 목적이 있습니다.

따라서, 작성자가 작성한 내용에 대해 별도의 동료 검토 절차(Submit for review)를 거치지 않고 자유롭게 퍼블리싱(Merge)할 수 있습니다.

Knowledge base는 여러 저자가 공동으로 편집함으로 인해, 편집중 다른 저자의 Merge 가 발생할 수 있습니다. Gitbook은 자동으로 업데이트 된 내용들을 Merge 합니다.

(이 경우 편집 시 'Update' 아이콘이 뜨며, 'Update'를 수행하여 편집을 계속하거나, 'Merge'를 수행하면 자동으로 'Update'된 내용을 반영하여 Merge가 됩니다. )

2. 작성자에게 문의나 수정을 요청할 경우

Gitbook의 comment 기능을 이용하여, 작성내용에 대해 문의나 수정사항을 요청하실 수 있습니다.

  1. Gitbook에 로그인하여 왼쪽의 Sidebar 에서 'Knowledge Base' 스페이스를 선택합니다.

  1. 수정 요청할 내용을 포함한 페이지의 문단을 선택한 후 오른쪽 상에 표시되는 'comment' 아이콘을 클릭하여, 요청사항을 메모합니다.

  1. 저자는 수정 작성 후 'Merge'를 실행하여, 새로이 수정된 내용을 퍼블리싱할 수 있습니다.

'comment' 작성 시, 작성자에게 알림을 위해 반드시 @ 을 이용하여 저자의 Gitbook ID를 지정해주시길 바랍니다.

3. 작성내용을 추가하여, 원 저작자에게 검토를 요청할 경우

작성자의 원작 내용에 추가 내용을 작성할 경우, 아래의 절차에 따라 원작자에게 검토(Submit for review)를 요청하실 수 있습니다.

보다 자세한 절차에 대한 설명은 '온라인 메뉴얼, Technical Support 문서 퍼블리싱 하기'를 참조하시길 바랍니다.

  1. Space 우측 상단의 'Edit' 버튼을 클릭하여 문서 작성을 시작합니다. 검토 요청을 하기 전 작성에 시간이 소요되는 경우 'Draft' 버전을 이용하여 지속적인 업데이트를 하시길 바랍니다.

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

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

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

      • 예) '문서의 버전관리 내용 업데이트' 등.

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

      • 예) 문서의 버전관리 페이지의 설명 오류를 수정하였으며, 이에 대한 검토를 요청. @원저작자

  4. 원저자는 수정 내용을 검토 후 'Merge'를 실행하여, 새로이 수정된 내용을 퍼블리싱할 수 있습니다.

4. Merge 시 충돌(Conflicts)이 날 경우

Merge 시 'Conflicts'가 발생할 경우 Conflicts가 발생한 부분을 직접 수정하실 수 있습니다.

직접 수정을 하지 않고 Conflicts 버전을 선택하여 자동 Merge를 진행할 경우, 충돌이 발생한 버전(선택하지 않은 버전)의 업데이트 내용은 삭제 되므로 주의하시길 바랍니다.

자동 Merge를 진행할 경우 타인이 작성한 버전을 유지(선택)하도록 권장합니다.

Creative Commons License