시스템 운영 문서를 작성할 때 주의한 점을 구체적으로 설명
운영 지침이나 작업 정책을 처음 작성할 때 가장 어려웠던 건 읽는 사람이 처음 접하는 사람이라고 가정하는 것이었습니다. 작성자 입장에서는 당연한 내용이 독자에게는 낯설 수 있고, 생략된 전제가 오해의 원인이 됐습니다. 순서를 명확히 하고 단계마다 결과 상태를 명시하는 방식이 오류를 줄였습니다.
예외 상황과 에러 발생 시 대응 방법을 함께 담지 않으면, 현장에서 정책을 따르다 예외가 생겼을 때 임의로 판단하게 됩니다. 버전과 작성 날짜를 항상 기록하는 것도 중요한데, 오래된 지침인지 모르고 따르는 경우가 실제로 있었습니다. 실제 운영자가 한 번 읽고 직접 해볼 수 있는지 동료에게 검토를 요청하는 단계를 거치는 게 효과적이었습니다.
정책 문서의 가치는 얼마나 상세하냐보다 현장에서 실제로 따를 수 있느냐에 있습니다.