Diátaxis 문서 계획기
Diátaxis Documentation Planner
지금 쓰려는 문서가 튜토리얼인지 하우투인지 레퍼런스인지 설명인지 판정하고, 그 유형에 남겨야 할 것과 다른 문서로 빼야 할 것을 목록으로 보여줍니다. 목차를 붙여넣으면 어느 섹션이 새고 있는지도 짚어줍니다.
Diátaxis는 문서를 네 가지로 나눕니다. 라벨을 붙이는 게 목적이 아니라, 지금 쓰려는 문단이 이 문서에 남아도 되는지 판단하는 기준을 얻는 게 목적입니다.
1단계 · 지금 쓰려는 글은 어느 쪽입니까
독자가 이 문서를 읽으며 직접 손을 움직인다
독자가 명령어나 코드를 그대로 따라 친다
독자가 먼저 개념을 이해해야 한다
독자의 질문은 "왜 이렇게 되어 있나"에 가깝다
독자에게 이미 끝내야 할 구체적인 일이 있다
독자는 업무 중에 급하게 이 문서를 연다
독자는 이 제품을 처음 접한다
경로는 우리가 정해주고, 독자는 선택하지 않는다
2단계 · 판정
이 문서는 하우투 가이드입니다
할 일이 있는 사람이 그 일을 끝내는 글
- 실천 ↔ 이론
- 0
- 학습 ↔ 업무
- 0
- 확신도
- 0%
경계에 걸쳐 있습니다
답이 축의 중앙에 몰려 있습니다. 이대로 쓰면 레퍼런스 쪽으로 흘러가다가 둘 다 못 하는 문서가 됩니다. 독자를 한 명만 정하고 다시 답해 보세요.
여기 있어야 하는 것
- ✓ 독자가 이미 가진 문제에서 시작
- ✓ 기본기는 안다고 가정
- ✓ 실제 순서대로, 필요한 만큼만
- ✓ 상황별 분기와 조건 허용
여기서 빼야 하는 것
- ✕ 설치와 첫 실행 같은 기초→ 튜토리얼로
- ✕ 개념 설명과 배경 이론→ 설명로
- ✕ 모든 파라미터를 나열한 표→ 레퍼런스로
이 유형이 실패하는 방식
기초 설명을 다시 시작해서 정작 문제를 못 풉니다. 하우투는 독자가 이미 급하다는 전제 위에 섭니다.
3단계 · 목차 점검
유형은 제목만 보고 추측한 값입니다. 틀렸다면 직접 바꾸세요. 판정 결과는 여러분이 고른 값으로 계산합니다.
목차를 입력하면 점검 결과가 나옵니다.