🅱️

[Black Anchor] TYPE - B 문서 작성 가이드

‣

0. 개요 및 의도

1. 기본 페이지

  • TYPE - B 문서를 열면 바로 확인 가능한 기본 페이지입니다.
  • 기본 템플릿 적용이 되어있으나, 의도에 따라 어느 정도 응용을 더합니다.

1.1. 속성

1.1.1. Status

  • 문서의 작업 상태입니다.
  • 작업이 필요하나 우선순위가 높지 않아 작업 시작 전일 경우, [작업 전] 태그를 사용합니다.
  • 문서를 작업중이거나 업데이트 사항 반영중일 경우, [작업중] 태그를 사용합니다.
  • 문서 작업이 완료된 경우, [작업 완료] 태그를 사용합니다.

1.1.2. 분류

  • 문서의 개괄적인 분류입니다.
  • 중복 사용이 가능합니다.
  • 분류 기준 추가/제거/업데이트 등이 필요할 경우, 논의 후 @Untitled 가 관리합니다.

1.1.3. 담당자

  • 문서의 담당자입니다.
  • 작성자 외에도 문서 업데이트 시 이를 알아야 할 모든 담당자를 태그합니다.

1.1.4. 설명

  • 문서의 개괄적인 설명입니다.

1.1.5. 참고(원본링크)

  • TYPE A 문서 등 참고된 문서 링크를 작성합니다.
  • 참고 문서가 여러 개일 경우, Shift + Enter로 줄바꿈하여 링크를 작성합니다.

1.1.6. 최종 편집 일시

  • 문서가 마지막으로 수정된 시간입니다.
    • 기본 페이지 내 수정이 있었을 경우에만 적용됩니다.
    • 문서 내 데이터베이스 내용 변경 등에는 적용되지 않습니다.
  • 자동 적용/업데이트되는 내용입니다.

1.1.7. 최종 편집자

  • 문서를 마지막으로 수정한 사람입니다.
    • 기본 페이지 내 수정이 있었을 경우에만 적용됩니다.
    • 문서 내 데이터베이스 내용 변경 등에는 적용되지 않습니다.
  • 자동 적용/업데이트되는 내용입니다.

1.2. 페이지 구성

  • TYPE - B 문서 생성 시, 기본 템플릿으로 적용되는 페이지의 내용입니다.

1.2.1. 목차

  • 페이지 최상단 좌측에 위치한 목차 페이지입니다.
  • 본문 부분에서 [제목 1, 2, 3]으로 설정된 블록들이 자동으로 등록됩니다.

1.2.2. History

  • 문서의 변경 내역을 기록하는 데이터베이스입니다.
  • 버전 단위로 페이지를 생성, 페이지 내에서 변경점을 작성합니다.
  • 자세한 히스토리 관리 방법은 아래를 참고해주세요.

1.2.3. 용어 정리

  • 문서 내에서 사용되는 용어를 정리하는 데이터베이스입니다.
  • 문서 내용과 관련된 기획 용어, 해당 문서에서만 사용하는 문서 내 용어 등을 개별 페이지로 작성합니다.

1.2.4. 본문

  • 문서의 내용이 작성되는 부분입니다.
  • 콜아웃, 데이터베이스 링크 등의 방법으로 가독성을 높이는 방법으로 작성합니다.

2. 문서 작성 방법

2.1. History

  1. 최초 페이지 생성 시 최소 기준(EA)과 함께 데이터베이스가 생성되어 있습니다.
  2. History 데이터베이스 명을 {문서 이름} History로 변경합니다.
  3. 변경점이 있는 신규 버전명으로 페이지를 생성합니다.
    1. Status의 경우, 최신인 버전은 New, 이외 버전은 모두 Legacy로 처리합니다.
    2. 기준일은 빌드 날짜입니다.
    3. New인 페이지의 경우, 아이콘을 주의 표시로 변경합니다.
  4. 아래의 본문 작성 이후, 관계형 속성으로 작성된 개별 변경 사항을 페이지 내에 작성합니다.
    1. 변경 사항은 링크가 아닌 맨션 상태로 작성합니다.
    2. 변경 내용에 따라 변경 상태 앞에 [신규], [변경], [삭제]를 표시합니다.
    3. 페이지 내용 전체를 동기화 블록으로 지정합니다.

2.2. 용어 정리

  1. 최초 페이지 생성 시 용어 정리 데이터베이스가 생성되어 있습니다.
  2. 용어 정리 데이터베이스 명을 {문서 이름} 용어 정리로 변경합니다.
  3. 데이터베이스에 본 문서의 History를 관계형 속성으로 추가합니다.
    1. 제한은 1개 페이지로 설정합니다.
    2. History 문서에 표시 항목을 On 합니다.
  4. 대분류에 본 문서에서 필요한 구분을 추가합니다.
    1. 문서 내 용어의 경우, 본 문서에서만 사용되는 특별한 서술 방식입니다.
  5. 이외 문서 내에서 필요한 별도 속성들을 추가합니다.
  6. History 속성에 해당 용어에 마지막으로 변경점이 있었던 버전을 지정합니다.
  7. “요약” 속성에 해당 용어에 대한 간략한 내용을 서술합니다.
  8. 페이지 내 “상세” 란에 해당 용어에 대한 자세한 내용을 서술합니다.
    1. 가급적 이미지를 첨부합니다.
  9. 상세 란에 기술된 내용을 동기화 블록으로 지정합니다.
  10. 이외 기획 의도, 비고는 필요 시 기술합니다.

2.3. 이외 문서 내 데이터베이스 사용

  • 문서 내 서술되는 모든 내용은 데이터베이스의 형태로 작성합니다.(예시)
  • 이에 따라 문서 내 다수의 데이터베이스 종류가 존재해도 무방하며, 기능 서술에 적합한 형태로 자유롭게 제작합니다.
    • 단, 모든 데이터베이스에는 해당 문서의 History를 관계형 속성으로 추가, 기술합니다.
      • 제한은 1개 페이지, History 문서에 표시 항목은 On 합니다.

2.4. 본문

  • 문서 내 제목 1, 2, 3 블록의 표기 방식은 1. {내용}, 1.1. {내용}, 1.1.1. {내용}의 형태로 통일합니다.
  • 문서 내 데이터베이스 첨부 시, “링크된 데이터베이스 보기”를 활용합니다.
    • 가급적 History 속성은 문서 가장 왼쪽에 배치합니다.
  1. 목차 바로 아래에 있는 History 토글 목록 블록 내에 해당 문서의 History 데이터베이스를 첨부합니다.
  2. 0. 문서 내 용어 정리 항목은 용어 정리 내용 중 “문서 내 용어” 속성인 문서가 있는 경우에 작성합니다.
  3. 이외 본문 내용은 문서의 형태에 따라 가독성이 편한 형태로 작성합니다.
    1. 다만, 가급적 해당 내용의 데이터베이스를 첨부합니다.
    2. 콜아웃 블록을 사용하면 조금 더 편하게 가독성을 높일 수 있습니다.

3. Archive History

  • Archive History는 작성된 모든 문서의 변경 사항을 한번에 확인할 수 있는 패치 노트 개념의 데이터베이스입니다.
  • 데이터베이스 내 신규 버전 명으로 페이지를 작성합니다.
  • 날짜의 경우, 빌드일을 기준으로 작성합니다.
  • (작성된) 모든 문서에 대한 관계형 속성이 존재합니다.
    • 이 관계형 속성은 일방향으로, 개별 문서 History 속성에는 표시되지 않습니다.
  • 변경이 있었던 모든 문서의 History 페이지를 태그합니다.
  • 변경이 있었던 모든 문서의 History 페이지 내 동기화 블록을 복사하여 붙여넣습니다.
‣

4. QnA(작성중)