Skip to content

문서 작성 지침 (Documentation Guidelines)

본 문서는 Project Nullspace 내 모든 문서(.md) 작성 시 준수해야 할 원칙과 스타일 가이드를 정의한다.

1. 문체 및 어조 (Tone & Style)

A. 평어체 사용 (Plain Text)

  • 모든 문장은 경어체(~합니다)가 아닌 **평어체(~한다)**로 작성한다.
  • 개조식(~함, ~임)보다는 주어와 서술어가 포함된 완성된 문장을 선호한다.
    • Bad: 입법예고 정보를 수집하여 제공함.
    • Good: 입법예고 정보를 수집하여 시민들에게 제공한다.

B. 명확성과 간결성

  • 불필요한 수식어를 배제하고 핵심 내용을 명확하게 전달한다.
  • 모호한 표현보다는 구체적인 사실과 근거를 제시한다.

2. 문서 구조 (Structure)

  • 제목: 문서의 내용을 포괄하는 명확한 제목을 # (H1) 태그로 작성한다.
  • 계층 구조: 내용은 ## (H2), ### (H3) 등을 사용하여 논리적인 계층 구조로 나눈다.
  • 강조: 핵심 키워드나 중요한 문구는 **굵게** 표시하여 가독성을 높인다.

3. 용어 통일 (Terminology)

  • 법통 Core: 본 프로젝트의 기반 기술을 지칭할 때는 항상 '법통 Core' 또는 'Beoptong Core'로 표기한다.
  • 서비스명: 각 서비스의 공식 명칭(예: beopmang.org, 판례.kr 등)을 정확히 사용한다.