특별 고지는 전문 기술 문서의 중요한 기능입니다: 독자가 읽고 있는 내용을 이해하고, 원하는 작업을 수행하며, 장비 손상을 방지하고, 자신이나 타인을 다치게 하지 않기 위해 알아야 할 중요한 정보를 강조합니다.

매우 특별한 공지사항. 최첨단 공지사항과 재치 있는 코멘트.

특정 유형의 공지에 대한 지침

이 장에서는 특정한 공지 스타일을 제시합니다. 다른 스타일과 형식도 존재한다는 점을 반드시 유의하세요.

  1. 핵심 사항을 강조하거나 독자에게 손상 또는 부상에 대해 경고하거나 주의시키기 위해 특별 고지를 사용하세요.
  2. 특수 고지의 유형을 그 정의된 목적에 맞게 정확히 사용하도록 주의하십시오. 다음과 같이 네 가지 특수 고지 유형을 사용하십시오:

    참고—요점이나 상기시킬 사항을 강조하거나 절차상의 사소한 문제를 나타내기 위해.

    주의—독자들에게 장비나 데이터의 손상 가능성, 수행 중인 작업 결과에서 발생할 수 있는 문제 또는 당혹감과 같은 잠재적 부정적 경험에 대해 경고하기 위해

    경고—독자들에게 자신이나 타인의 경미한 부상 가능성에 대해 경고하기 위해.

    위험—독자들에게 자신 또는 타인이 심각하거나 치명적인 부상을 입을 수 있음을 경고하기 위해

참고: 차고나 부엌을 둘러보고 제품에 붙어 있는 특수 안내문을 살펴보세요. 다양한 차이를 보게 될 텐데, 이는 특정 산업이나 기업의 기준에 따라 달라질 가능성이 큽니다.

어떤 유형의 공지를 사용할지 결정하는 것은 정확한 과학이 아니다. 경고가 더 적절할 때 위험 공지를 사용하지 마십시오(이는 "거짓 경보를 울리는 것"과 같습니다). 또한 문서 전반에 걸쳐 공지를 일관되게 사용하십시오. 하십시오 아니다 자신만의 공지를 만드세요. 예를 들어 "중요:"을 "경고." 대신 넣을 수 있습니다.

  1. 텍스트에서 필요한 지점에 특별 공지를 배치하세요. 예를 들어 '주의' 또는 '위험' 공지를 배치하세요. 바로 전에 또는 직후 독자가 스스로 다칠 수 있는 단계를 논의하는 것.
  2. 텍스트의 어느 한 지점에 너무 많은 특별 공지를 두지 마십시오. 그렇지 않으면 그 특별 형식의 효과가 떨어집니다. (너무 많다면 합치세요.)
  3. 경고, 주의 및 위험 고지와 함께 고지 사항에 주의를 기울이지 않았을 때의 결과를 설명하십시오. 독자가 고지 사항을 따르지 않을 경우 어떤 일이 발생하는지 명확히 명시하십시오.
  4. 이 섹션의 예제들은 굵은 글씨를 사용합니다. 특별 공지의 텍스트에는 전체 대문자 사용을 피하세요.

참고: 적절히 구성된 게시 환경에서는 기술 문서 작성자가 어떤 유형의 고지를 사용할지 결정하거나 고지 문구를 직접 작성할 필요가 없다. 그것은 조직의 변호사들이 맡아야 할 일이다. 하지만 그들 변호사들이 당신의 고지를 검토할 만큼 바쁠 수 있어 부담은 여전히 기술 문서 작성자나 편집자인 당신에게 남을 수 있다.

특별 공지 양식

각 유형의 특수 공지에 대한 대문자 사용, 타이포그래피(굵게, 밑줄, 서로 다른 글꼴, 서로 다른 글자 크기) 및 간격에 관한 구체적인 세부사항에는 다음을 사용하십시오.

참고

간단한 메모에는 다음 형식을 사용하세요:

  1. 레이블 "참고" 다음에 콜론을 입력하세요. (다음 예시들 중 일부는 굵게 표시되어 있지만, 제목과의 시각적 혼동을 피하려면 기울임꼴을 사용하세요.)
  2. 콜론 다음에 한 칸 띄우고 메모 내용을 입력하기 시작하세요. (단, 메모 내용을 굵게나 기울임꼴로 표시하지 마세요.)
  3. 메모 본문은 단일 줄 간격으로 하고, 메모 위와 아래에는 한 줄을 띄우세요.
  4. 이어지는 줄은 일반 왼쪽 여백에서 시작하십시오.
  5. 참조하는 텍스트에 주석을 맞춰 정렬하세요(두 번째 예시에서 보여준 것처럼).


    6. 간단한 메모의 예


    글머리 기호 목록 안의 메모 예시(일반 본문 텍스트가 아님). 이와 같은 원칙(특별 공지가 참조하는 텍스트에 맞춰 정렬된다는 것)은 다른 유형의 특별 공지에도 마찬가지로 적용됩니다.

메모

여러 개의 노트에 대해서는 다음 형식을 사용하세요:

  1. 메모가 너무 많아 각각 따로 제시하면 산만해질 때 이 형식을 사용하세요.
  2. 레이블 "메모"을 입력한 다음 콜론(:)을 붙이세요. (다음 예들 중 일부는 굵게 표시되어 있지만, 제목과의 시각적 혼동을 피하기 위해 기울임꼴을 사용하는 것이 좋습니다.)
  3. 개별 노트에는 번호 매긴 목록을 사용하십시오. 그 안에서는 번호 매긴 목록의 규칙을 따르십시오. (개별 노트에는 굵은 글씨나 이탤릭체를 사용하지 마십시오.)
  4. 주석을 해당 본문과 정렬하되, 주석의 위와 아래 각각 한 줄 분량은 건너뛰세요.


    5. 여러 메모의 예. 메모가 많고 산만함을 방지하기 위해 모두 한곳에 모으고 싶다면 이 형식을 사용하세요.

주의

주의 문구에는 다음 형식을 사용하세요:

  1. 레이블 "주의"을 입력한 뒤 콜론을 붙이고 레이블과 콜론을 둘 다 굵게 표시하세요.
  2. 한 줄을 띄운 다음 주의 문구의 텍스트를 주의 라벨의 시작 부분에 맞춰 시작하세요.
  3. 경고 문구의 텍스트를 단일 줄 간격으로 하고, 공지 위아래로 한 줄씩 띄우세요.
  4. 주의 고지를 관련 텍스트와 맞추세요(앞의 예에서는 경고 고지가 번호 매겨진 목록 안에 있어 그에 따라 들여쓰기되어 있습니다).


    5. 주의 안내문의 예시. 장비 손상 가능성이나 절차상의 문제를 독자에게 알리려면 이것을 사용하세요.

경고

경고에는 다음 형식을 사용하세요:

  1. 레이블 "Warning,"을 입력하고 그것을 기울임꼴로 표시한 다음 콜론(:)을 붙이세요.
  2. 경고 텍스트의 시작 부분까지 탭을 넣거나 행걸이 들여쓰기 형식을 사용하십시오(이 방식이 훨씬 낫습니다). 아래 예시의 경고문에 대한 행걸이 들여쓰기 형식은 탭과 행걸이 들여쓰기 모두에 0.63인치를 사용하지만 글꼴 크기에 따라 이 값은 달라질 수 있습니다.
    참고: 보다 걸이 들여쓰기를 만드세요. Microsoft Word에서 행걸이 들여쓰기 형식을 만드는 동영상용.
  3. 경고 고지문의 텍스트에는 일반 본문 글꼴을 사용하세요(굵게, 기울임, 전체 대문자, 색상 사용 금지).
  4. 경고 고지를 해당 텍스트에 맞춰 정렬하십시오.
  5. 경고문 위아래로 각각 한 줄 분량을 건너뛰세요.


    6. 경고 안내문 예시. 독자들에게 경미한 부상의 가능성이 있음을 알리려면 이것을 사용하세요.

위험

위험 공지에는 다음 형식을 사용하세요:

  1. 라벨 "위험"을 모두 대문자 굵은 글씨로 입력하세요.
  2. 경고문을 해당 텍스트와 정렬하세요.
  3. 위험 고지문의 텍스트는 단일 줄 간격으로 작성하고, 그 위와 아래에 한 줄씩 띄우세요.
  4. 위험 안내문 텍스트가 있다면 굵게 표시하세요(하지만 절대로 모두 대문자로 쓰지 마세요).
  5. 그래픽 기능이 있다면 라벨을 포함하여 위험 고지 주변에 상자를 그려 주세요.

    6. 위험 경고. 독자들에게 심각한 부상 또는 사망의 가능성이 있음을 알리려면 이것을 사용하세요.

알림 이미지(아이콘)

보시기 바랍니다. 일반 공지 이미지.

기타 서식 문제

특별 공지에 관해 고려해야 할 추가 사항은 다음과 같습니다:

특수 정렬. 특별한 공지는 그것이 참조하는 텍스트에 맞추어 정렬되어야 합니다. 예를 들어, 글머리 기호 목록 항목의 어떤 내용에 대해 특별한 세부사항을 덧붙이는 메모가 있다면, 그 메모를 텍스트 글머리 기호 항목의. 물론, 메모가 글머리 기호 목록 뒤에 오지만 전체 목록을 가리키는 경우라면 일반 왼쪽 여백을 사용할 수 있습니다.

    • 줄간격이 단일인 텍스트. 이 단원의 모든 예와 논의는 단일 줄 간격의 텍스트를 기준으로 합니다. 본문과 특별 공지— 사이에는 상황에 따라 보기 좋은 쪽을 택해 한 줄의 공백을 두십시오. (물론 본문과 특별 공지의 텍스트는 모두 단일 줄 간격입니다.)

    특별 공지의 배치. 특별 공지사항을 배치하세요. 바로 전에 또는 바로 후에 그들이 관련되는 시점입니다. 예를 들어, 독자들에게 모든 데이터를 백업하라고 경고할 수 있습니다. 전에 당신은 그들에게 하드 드라이브를 재포맷하라고 말합니다. 그러나 실제로는 데이터, 장비 또는 사람에게 큰 피해를 초래할 가능성이 있는 절차의 맨 처음에 중대한 특별 주의 사항이 배치됩니다.

    아주 신중한 작가들이(어쩌면 과거에 문제가 있었던 이들일 수도 있다) 사용하는 한 가지 기법은 문서의 시작 부분 어딘가에 모든 심각한 공지(경고, 주의, 위험)를 배치한 다음, 해당되는 곳에서 개별적으로 다시 반복하는 것이다. 조직은 공지의 배치에 대한 요구사항을 명시한 스타일 가이드를 가지고 있을 가능성이 높다.

    특별 공지 의미 도표. 사용자 안내서는 종종 서문에 서로 다른 유형의 공지의 의미를 정리한 표를 배치하며, 이 그림의 하단에 그 일부가 예시되어 있다. 이 예에서는 ‘주의(caution)’ 유형의 공지가 없다는 점에 유의하라. 단지 공지가 업계별로 어떻게 다른지를 보여주기 위한 것이다:

    Chart of notice types
    공지사항 차트. 이 예에서는 '주의' 공지 유형이 없다는 점을 알 수 있으며, 이는 공지가 업계마다 어떻게 다른지를 보여줍니다.

    여러 개의 특별 공지. 문서의 동일한 부분에 특별 공지 세 개나 네 개가 서로 이어져 한데 몰려 있는 상황을 마주치곤 한다. 이는 문제가 된다. 공지에 부여한 특수한 서식의 의도가 사라지기 때문이다. 어떤 것이 특별하다는 것은 그것이 주변과 달라야 하기 때문이다. 이 문제의 해결책은 하나의 식별용 제목(예: "참고 및 경고")을 만들고, 그 아래에 공지들을 글머리표나 번호로 나열하는 것이다.

    관련 정보

    위험, 경고, 주의 또는 안내 표지에 대한 ANSI 정의다운로드 가능한 이미지가 포함되어 있습니다.
    1910.145 - 사고 예방 표지 및 태그에 대한 규격. 미국 산업안전보건청
    OSHA 안전 표지 카테고리 (50487)다운로드할 수 있는 이미지가 많이 있습니다.
    안전 표지의 색상은 무엇을 의미하나요?. 다운로드 가능한 이미지가 포함되어 있습니다. 크리에이티브 새프티 서플라이

    이 장에 대한 귀하의 생각, 반응, 비판을 알려주시면 감사하겠습니다: 당신의 응답—데이비드 맥머리.