야간 교대 절차은(는) 무엇을 하나요?

이 기술의 목적

대부분의 절차는 이미 업무를 아는 사람이 작성합니다. 책상 앞에서 읽으면 괜찮아 보입니다. 하지만 새벽 3시, 시끄러운 방, 휴대폰 화면, 제2외국어, 또는 무언가 망가뜨릴까 두려워하는 독자에게는 실패합니다. 실패는 예측 가능합니다. 한 단계에 두 개의 동작이 숨겨져 있거나, 경고가 보호해야 할 단계 다음에 있거나, 조건이 문장 끝에 등장하거나, 누가 행동해야 하는지 숨기는 수동태 문장, 또는 '적절히'처럼 독자가 추측하게 만드는 단어들 때문입니다.

이 기술은 이러한 텍스트를 문자 그대로 따라할 수 있는 단계로 바꿉니다. 항공기 및 산업 정비 분야의 통제 언어(짧은 문장, 한 동작당 한 문장, 능동태, 하나의 개념에 하나의 용어), 장비 라벨의 안전 메시지 순서(신호어, 위험, 결과, 회피 방법), 그리고 위험한 단계 후에 예상 결과를 기록하여 독자가 중단해야 할 시점을 알게 하는 관행을 차용합니다.

"인간적으로 보이게" 만드는 작업이 아닙니다. 목표는 다소 평범해 보일지라도 잘못 읽을 수 없는 절차를 만드는 것입니다.

사용 시기

런북, 사건 대응 플레이북, 당직 체크리스트, 배포 및 롤백 절차
하드웨어, 가정용 기기, 실험실 장비, 사무실 IT의 설정 또는 수리 가이드
표준 운영 절차(SOP) 및 다른 사람이나 다음 교대를 위한 인수인계 노트
기계 번역되거나 비원어민이 읽을 지침
한 번의 잘못 읽기로 데이터, 비용 손실 또는 부상을 초래할 수 있는 모든 텍스트

에세이, 마케팅 카피, 개념 설명에는 사용하지 마십시오. 그러한 문서는 다른 어조가 필요합니다.

규칙 (기본 수준)

#	규칙	제한 또는 테스트
R1	단계당 하나의 동작	단계 내에 ", then", "and then", ";" 또는 "and"로 연결된 두 개의 동사 금지
R2	짧은 명령문	영어 20단어, 중국어 약 35자
R3	짧은 서술문	영어 25단어, 중국어 약 45자
R4	명령형, 능동태	동사로 시작하십시오. 행위자가 독자가 아닌 경우 행위자를 명시하십시오
R5	조건 우선	"빨간불이면 정지하십시오." "정지, 빨간불이면" 안 됨
R6	하나의 단어, 하나의 의미	용어를 용어집에 고정하십시오. 다양성을 위해 동의어를 교체하지 마십시오
R7	정확한 값	단위가 있는 숫자, 화면이나 장치에 정확히 표시된 라벨
R8	단계 전 안전 메시지	신호어, 위험, 결과, 수행할 작업
R9	위험 단계 후 예상 결과	"결과: ..." 및 결과가 다를 경우 수행할 작업
R10	추측 단어 금지	"적절히", "필요에 따라", "확인", "~해야 한다", "그냥" 제거

엄격 수준 (안전 중요 또는 규제 텍스트의 경우): 모든 규칙을 예외 없이 적용하고, 어떠한 애매한 표현도 허용하지 않으며, 모든 단계 뒤에 결과 줄을 넣습니다. 가벼운 수준 (이미 괜찮은 내부 메모의 경우): R1, R5, R8 및 R9만 적용합니다.

신호어

가장 낮은 수준의 신호어를 사용하십시오. 과장하지 마십시오.

위험: 무시할 경우 사망 또는 심각한 부상을 초래합니다.
경고: 사망, 심각한 부상, 또는 중요한 데이터나 비용 손실을 초래할 수 있습니다.
주의: 경미한 부상 또는 수리 가능한 손상을 초래할 수 있습니다.
알림: 부상 위험 없음. 재산, 데이터 또는 시간 손실 위험만 있습니다.

모든 안전 메시지는 세 부분으로 구성됩니다: 위험이 무엇인지, 독자가 무시할 경우 어떤 일이 발생하는지, 그리고 무엇을 해야 하는지. "조심하십시오"는 안전 메시지가 아닙니다.

작업 방법

절차 카드를 작성하십시오. 편집하기 전에 다음을 기록하십시오: 목표 상태("디스크 2 재구축 중"), 누가 따를 것인지(역할, 언어, 장갑, 소음, 휴대폰 화면, 야간 등의 조건), 그들이 가진 것(접근 권한, 도구, 시간), 위험, 중지 조건. 추론할 수 없는 것은 사용자에게 물어보십시오. 누락된 중지 조건이 가장 흔한 결함입니다.
유지해야 할 사실을 나열하십시오. 모든 숫자, 단위, 라벨, 명령, 순서 제약 조건, 경고 및 조건. 재작성은 이 모두를 포함해야 하며 어떤 것도 추가해서는 안 됩니다. 값이 잘못되었다고 생각되면 표시하십시오. 조용히 고치지 마십시오.
동작으로 분할하십시오. 독자가 수행하는 하나의 동사 = 하나의 단계입니다. 탐색도 포함됩니다("저장소로 이동"과 "디스크 2 선택"은 두 단계입니다). 배경 정보는 짧은 "시작하기 전에" 단락으로 이동하십시오.
각 단계를 재작성하십시오. 동사 먼저, 조건 먼저, 정확한 라벨은 굵게 또는 코드로, 단위는 항상 표시하십시오. 행위자를 숨기는 모든 수동태를 교체하십시오. "키가 생성됩니다"는 "도구가 키를 생성합니다" 또는 더 나은 방법은 독자가 키를 생성하기 위해 수행하는 단계로 바꾸십시오.
안전 메시지를 배치하십시오. 삭제, 덮어쓰기, 전원 끄기, 재시작, 연결 해제, 가열, 절단 또는 가압하는 각 단계에 대해 단계 바로 위에 메시지를 배치하십시오. 위 계층에서 신호어를 선택하십시오.
결과 및 종료 지점을 추가하십시오. 각 위험하거나 상태를 변경하는 단계 후에, 작업이 성공했을 때 독자가 보게 되는 내용을 기록하십시오. 결과가 다를 수 있는 경우, 한 줄을 추가하십시오: "X가 보이면 중지하고 복구 A로 가십시오." 복구 섹션을 작성하십시오.
용어집을 고정하십시오. 각 항목에 대해 하나의 용어를 선택하십시오(예: "트레이", "캐디" 또는 "슬레드"가 아님). 절차가 유지 관리될 경우 glossary.json으로 저장하십시오.
린트를 수행하십시오. python scripts/stepcheck.py lint procedure.md --glossary glossary.json을 실행하십시오. 모든 UNSAFE 및 REWORK 발견 사항을 수정하거나, 하나가 거짓 긍정인 이유를 설명하십시오.
문자 그대로의 연습을 수행하십시오. 각 문장이 정확히 말하는 대로만 수행하고 그 이상은 하지 않는 사람처럼 번호가 매겨진 단계만 읽으십시오. 그들은 어디에서 멈추고, 추측하고, 해로운 행동을 할까요? 그 부분을 수정하십시오.
재작성된 절차를 반환한 다음, 짧은 변경 목록(규칙 번호), 확인할 수 없었던 사실 목록, 그리고 열린 질문을 반환하십시오.

도우미 스크립트

scripts/stepcheck.py는 표준 라이브러리 파이썬으로 작성된 마크다운 절차(영어 또는 중국어)용 린터입니다.

코드	심각도	의미
HAZARD-NO-WARNING	하드	위험한 단계 위에 안전 메시지가 없음
LATE-WARNING	하드	안전 메시지가 보호해야 할 단계 다음에 위치함
WEAK-WARNING	수정	메시지가 어떤 일이 발생하는지 명시하지 않음
LONG	수정	명령문이 제한을 초과함
STACKED	수정	단계에 두 개 이상의 동작이 있음
HIDDEN-ACTOR	수정	수동태 또는 被가 행위자를 숨김
HEDGE / VAGUE	수정	추측 단어
CONDITION-LAST	수정	조건이 동작 뒤에 옴
DRIFT	수정	용어집에서 금지된 동의어 사용
NO-RESULT, LONG-DESC	참고	조언만 해당

평결: 준비됨 (종료 코드 0), 재작업 필요 (종료 코드 1), 안전하지 않음 (종료 코드 2). 이 스크립트는 단어 목록과 패턴을 사용하므로 일부를 놓치고 때로는 올바른 문장에 플래그를 지정합니다. 9단계를 대체하지는 않습니다.

예시

변경 전:

NAS가 아직 실행 중이면 전원을 끄십시오.

디스크 2 트레이를 당겨 빼고 새 디스크를 넣으십시오. 주의: 기존 디스크가 뜨거울 수 있습니다.

변경 후:

경고: 디스크를 제거하기 전에 NAS 전원을 끄십시오. 실행 중인 상태에서 디스크를 제거하면 두 번째 디스크가 손상될 수 있습니다. 5. 전원 버튼을 2초 동안 눌러 NAS 전원을 끄십시오. 결과: 약 1분 후 전면의 모든 표시등이 꺼집니다. 주의: 사용 후 기존 디스크가 뜨거울 수 있습니다. 트레이를 잡으십시오. 그렇지 않으면 손가락에 화상을 입을 수 있습니다. 6. 디스크 2 트레이를 당겨 빼십시오. 7. 새 디스크를 트레이에 넣으십시오.

변경 사항: R1(4단계 분할), R5(전원 끄기를 자체 단계로 만들어 조건 제거), R8(경고를 위로 이동하고 결과 추가), R9(결과 추가). 전체 파일은 examples/에 있습니다.

팁

원본 텍스트가 잘못된 경우, 아무리 명확하게 재작성해도 여전히 잘못됩니다. 변경 목록에 의심스러운 값을 표시하십시오.
명령, 경로 및 화면상의 라벨은 문자 그대로 유지하십시오. 잘못 입력된 명령 주변의 명확한 산문은 원본보다 더 나쁩니다.
긴 설명이 필요한 단계는 일반적으로 두 단계와 그 앞의 참고 사항입니다.
단계를 연속적으로 번호를 매기십시오. 하나의 절차 내에서 번호를 다시 시작하지 마십시오. 복구에는 별도의 섹션을 사용하십시오.
중국어 버전과 영어 버전을 함께 읽으십시오: 각 단계가 일대일로 매핑되어야 합니다.
출력이 공식적인 통제 언어 표준을 준수한다고 주장하지 마십시오. "통제된 스타일로 작성됨"이라고 말하십시오.

야간 교대 절차