지식 운영 샘플
지식 운영 샘플
이 문서는 문서를 오래 유지하기 위한 운영 기준 샘플이다. 새 문서를 많이 만드는 것보다, 이미 있는 문서를 찾고 갱신하고 닫는 흐름을 안정화하는 데 초점을 둔다.
원칙
- 새 사실은 먼저 내부 기준 문서나 작업 기록에 남긴다.
- 사용자에게 설명할 수 있는 기능만 배포 문서로 옮긴다.
- 문서가 오래되면 삭제보다 상태 변경을 먼저 검토한다.
- 같은 내용을 두 번 설명해야 하면 하나는 링크로 바꾼다.
문서 상태
| 상태 | 의미 | 다음 행동 |
|---|---|---|
| draft | 아직 검토 중인 내용 | 근거와 미결정을 보강한다 |
| active | 현재 기준으로 쓰는 내용 | 변경 시 영향 범위를 확인한다 |
| implemented | 구현과 검증이 끝난 내용 | 사용자 문서 반영 여부를 판단한다 |
| deprecated | 더 이상 권장하지 않는 내용 | 대체 문서를 명확히 연결한다 |
운영 루틴
주간 점검
- 최근 변경된 문서를 훑는다.
- 링크가 끊긴 문서를 찾는다.
- 표, 코드 블록, 긴 목록이 배포 결과에서 읽기 쉬운지 확인한다.
- 샘플 문서가 실제 기능보다 앞서 나가지 않았는지 확인한다.
릴리스 전 점검
- 사용자에게 보이는 기능 설명이 현재 구현과 맞는가?
- partial 기능을 shipped 기능처럼 설명하지 않았는가?
- 설정값, 파일 경로, 메뉴 이름이 실제 UI와 맞는가?
- 스크린샷이나 예시가 오래된 레이아웃을 암시하지 않는가?
연결 문서
변경 로그 템플릿
## 변경 로그
- 변경한 이유:
- 사용자에게 보이는 변화:
- 검증 방법:
- 배포 문서 반영 여부: