---
type: knowledge
domain: business
status: active
last-reviewed: 2026-07-07
---

# 기술 문서와 보고

> 한 줄 정의
> 문서의 목적은 기록이 아니라 **독자의 다음 행동**이다 — 읽고 나서 결정·실행·안심 중 무엇을 하게 할지가 먼저다. 말하기·협상은 [[협상과 커뮤니케이션]] — 여기는 쓰기의 실전이다.

## BLUF — 결론을 문서 첫 줄에

- 결론 → 근거 → 상세 순서 (피라미드 원칙). 배경부터 시작해 결론이 마지막에 나오는 문서는 바쁜 독자에겐 결론이 없는 문서다.
- 합격 기준: **어디서 읽기를 멈춰도 그때까지 읽은 것만으로 요지가 성립**해야 한다. 상세는 뒤로 밀수록 좋다.
- 제목도 BLUF다: "3분기 인프라 검토" → "3분기 인프라: DB 이중화가 필요합니다".

## 독자 역산 — 같은 내용, 다른 문서

| 독자 | 원하는 것 | 형식 |
|------|----------|------|
| 경영진·고객 결정권자 | 결정에 필요한 것만 | 1장: 결론 + 숫자 + 선택지와 추천 |
| 동료 엔지니어 | 맥락과 재현 가능성 | 배경 링크 + 절차 + 코드·명령 그대로 |
| 고객 실무자 | 자기 업무에 미치는 영향 | 효익 + 해야 할 일 + 마감 |
| 미래의 나 | 왜 이렇게 했는지 | 당시의 제약과 기각한 대안 (ADR) |

한 문서로 전부를 만족시키려는 것이 장문 문서의 흔한 사인(死因)이다 — 요약 1장 + 상세 부록으로 분리한다.

## 문서 유형별 뼈대

| 유형 | 뼈대 | 합격 기준 |
|------|------|----------|
| 주간 보고 | 한 일(결과로) → 다음 주 → 리스크·요청 | 리스크 칸이 비어 있지 않다 (항상 뭔가 있다) |
| 회의록 | **결정 · 담당 · 기한** 3열이 본체, 논의는 부록 | 회의 후 30분 내 공유 → [[협상과 커뮤니케이션]] "기록된 것만 합의" |
| README | 뭐하는 물건 → 5분 내 실행 성공 경로 → 다음 문서 | 처음 온 사람이 문서만 보고 실행에 성공 |
| ADR | 맥락 → 옵션과 트레이드오프 → 결정 → 결과 | 기각한 대안이 적혀 있다 (미래의 재논쟁 방지) |
| 제안서 | 문제 이해 증명이 본체 | → [[SI 수주와 범위 관리]] |
| 장애 보고 | 타임라인 → 영향 숫자 → 원인 → 액션 아이템 | → [[장애 대응 실전]] blameless |

## 나쁜 문서의 신호 — 셀프 체크

- **형용사가 숫자를 대신한다**: "매우 안정적" → "30일 에러율 0.02%". 형용사는 주장, 숫자는 근거다.
- **다음 행동이 없다**: 다 읽고 "그래서 나보고 뭘 하라고?"가 남으면 실패다. 요청·결정 요청·공유만임을 명시한다.
- **갱신 정보가 없다**: 작성일·기준 시점 없는 문서는 신뢰할 수 없어 결국 안 읽힌다.
- **모든 것이 강조돼 있다**: 볼드가 문단의 절반이면 강조는 0개다.

## 그림 한 장 > 산문 열 줄

- 구조·흐름·상태 전이는 다이어그램이 기본 (mermaid면 버전 관리도 된다).
- 표는 비교·목록에, 산문은 이유·맥락에 — 표에 긴 설명을 욱여넣거나 산문으로 5개 항목을 비교하는 것은 형식 미스매치다.

## 살아있는 문서 vs 스냅샷 — 구분이 없으면 부패한다

- **스냅샷** (회의록·보고서·ADR): 시점 기록, 갱신하지 않는 것이 정상.
- **살아있는 문서** (README·운영 가이드·API 문서): 갱신 책임자가 없으면 반드시 부패하고, 낡은 문서는 없는 문서보다 해롭다 (믿고 따르다 사고).
- 처방: 살아있는 문서는 소수만 유지하고 각각 갱신 트리거(예: 배포 절차 변경 시)를 명시한다 — 이 볼트의 `last-reviewed`가 같은 장치다.

## AI에게 초안을 맡길 때

- 초안·구조화·요약은 AI가 잘한다. **숫자·사실·약속(기한·범위)은 사람이 검증**한다 — 문서에 적힌 순간 그것은 조직의 발화가 된다.
- 검증 못 한 항목을 지우지 말고 표시하게 한다 (`미확인: ...`) → 정직 산출 계약 ([[S-skills-하네스-패턴]]).

## 관련 문서

- [[업무별 PPT 템플릿]] — 컨설팅·스터디·PoC·제안서·최종 보고서·화면 설계서 발표자료 뼈대
- [[협상과 커뮤니케이션]] — 말하기·나쁜 소식·요청의 형식
- [[SI 수주와 범위 관리]] — 제안서·결과보고서
- [[장애 대응 실전]] — 포스트모템 문서
- [[기획 원리]] — PRD로 이어지는 문서화
