기록 원칙
Case Writing Principles
사례는 작업 결과를 나열하는 문서가 아니라, 현장 조건과 설계 선택을 기록하는 문서이다.
이 페이지는 IP119 Case 채널에서 사례 문서를 어떤 기준으로 정리하는지 설명하는 원칙 문서이다.
01
사례는 홍보 자료가 아니다
'시공 사례 채널'은 "잘 끝났다"를 보여주기 위한 페이지가 아니다.
실제 현장에서 어떤 조건이 있었고, 어떤 판단이 필요했으며, 왜 그 구성을 선택했는지를 남기는 기록이다.
작업 결과보다 판단 과정과 구조가 중요하다.
02
무엇을 했는가보다 왜 그렇게 했는가
같은 환경, 같은 네트워크 구조라도 현장 조건에 따라 선택은 달라질 수 있다.
따라서 사례 문서는 작업 종류보다 선택 이유를 중심으로 정리한다.
- 왜 이 구조를 선택했는가
- 왜 다른 선택지를 쓰지 않았는가
- 무엇이 판단 기준이 되었는가
03
현장 조건을 먼저 기록한다
사례 문서는 결과부터 시작하지 않는다.
공간 구조, 기존 배선 상태, 단자함 상황, 장비 조건, 운영 환경처럼 판단의 전제가 되는 조건을 먼저 기록한다.
조건이 달라지면 같은 작업도 다른 사례가 된다.
04
한 사례는 한 판단 주제를 중심으로 쓴다
한 문서 안에 너무 많은 작업을 넣으면 기록의 중심이 흐려진다.
따라서 각 사례는 하나의 핵심 판단 주제를 중심으로 정리한다.
- 신규 구축
- 이전 재구성
- 확장
- 단자함 정리
- 장애 정리
05
반복 가능한 기준은 '기술 문서'로 연결한다
사례는 특정 환경에서의 판단 기록이다. 반복 가능한 일반 기준은 '기술 문서' 채널에서 정리한다.
따라서 Case는 문서 자체보다 판단 맥락을 남기고, 필요한 기준은 '기술 문서'으로 연결한다.
06
표준 문서 구조를 유지한다
각 사례 문서는 아래 구조를 기준으로 정리한다.
- 현장 개요
- 현장 조건
- 문제 또는 요구사항
- 고려한 선택지
- 최종 판단
- 구현 구조
- 결과
- 관련 문서
- 범위와 제외 사항