본문으로 건너뛰기

문서 기여 방식

중요도: 중요 · 새 지식이나 팀의 합의를 문서로 남길 때 읽습니다.

좋은 문서는 정보를 많이 담은 문서가 아니라, 다음 사람이 언제 읽어야 하고 무엇을 하면 되는지 알 수 있는 문서입니다.

새 문서를 만들기 전​

  1. 이미 같은 주제를 설명하는 문서가 있는지 검색합니다.
  2. 새 문서가 필요한 이유와 대상 독자를 한 문장으로 정합니다.
  3. 독자가 이 문서를 읽고 취할 다음 행동을 정합니다.

기본 구조​

---
title: 문서 제목
tags: [주제]
---

# 문서 제목

> **중요도: 필수 | 중요 | 참고** · 언제 읽는지 한 문장

## 핵심 요약
## 언제 사용하나요?
## 우리 팀의 기준
## 예시 또는 확인 방법
## 다음에 읽을 문서

이미지와 화면 캡처​

텍스트만으로 이해하기 어렵거나, 실제 UI에서 눌러야 할 위치가 중요한 경우에만 이미지를 사용합니다. 필요한 이미지는 본문에 아래처럼 전역 번호로 먼저 표시합니다.

[#번호 : 이미지 설명]

번호는 사이트 전체에서 중복하지 않습니다. 이미지를 받은 뒤에는 설명이 담긴 alt 텍스트와 함께 교체합니다. 장식용 이미지보다, 독자의 판단이나 행동을 돕는 이미지를 우선합니다.

작성 후 점검​

  • 제목만 훑어도 문서의 흐름이 보이는가?
  • 중요도와 읽는 시점이 적혀 있는가?
  • 팀 고유의 규칙에는 이유가 함께 있는가?
  • 다음 문서 또는 실제 행동으로 이어지는가?
  • 링크와 코드 예시는 실제로 동작하는가?