Thông báo đặc biệt là một đặc điểm quan trọng của việc viết kỹ thuật chuyên nghiệp: chúng làm nổi bật thông tin đặc biệt mà người đọc cần biết để hiểu những gì họ đang đọc, để hoàn thành những gì họ muốn làm, để ngăn ngừa hư hại cho thiết bị, và để tránh làm tổn thương bản thân hoặc người khác.
Thông báo rất đặc biệt. Thông báo hiện đại với những bình luận thông minh.
Hướng dẫn cho các loại thông báo cụ thể
Chương này trình bày một kiểu thông báo cụ thể. Hãy rất chú ý rằng có những kiểu và định dạng khác tồn tại.
- Sử dụng thông báo đặc biệt để nhấn mạnh các điểm chính hoặc cảnh báo hoặc nhắc nhở độc giả về thiệt hại hoặc chấn thương.
- Hãy cẩn thận sử dụng các loại thông báo đặc biệt một cách chính xác, theo mục đích đã định. Sử dụng bốn loại thông báo đặc biệt theo các cách sau:
Ghi chú—Để nhấn mạnh các điểm hoặc nhắc nhở, hoặc để chỉ ra các vấn đề nhỏ trong một quy trình.
Cảnh báoĐể cảnh báo người đọc về khả năng gây hại cho thiết bị hoặc dữ liệu, về những vấn đề tiềm ẩn trong kết quả của những gì họ đang làm, hoặc những trải nghiệm tiêu cực tiềm năng (như sự xấu hổ).
Cảnh báo—Để cảnh báo người đọc về khả năng bị thương nhẹ cho bản thân hoặc người khác.
Nguy hiểm—Cảnh báo người đọc về khả năng bị thương nghiêm trọng hoặc tử vong cho bản thân hoặc người khác.
Lưu ý: Hãy nhìn xung quanh nhà để xe hoặc bếp của bạn, và xem những thông báo đặc biệt trên các sản phẩm. Bạn sẽ thấy nhiều sự khác biệt, có khả năng phụ thuộc vào tiêu chuẩn của ngành hoặc doanh nghiệp cụ thể.
Việc quyết định loại thông báo nào để sử dụng không phải là một khoa học chính xác. Chỉ cần đừng sử dụng thông báo nguy hiểm khi một thông báo cảnh báo thì phù hợp hơn (cũng giống như "kêu gọi báo động"). Ngoài ra, hãy sử dụng các thông báo một cách nhất quán trên toàn bộ tài liệu. không tạo thông báo của riêng bạn, chẳng hạn như đặt "Quan trọng:" thay cho "Cảnh báo."
- Đặt các thông báo đặc biệt tại vị trí trong văn bản mà chúng cần thiết. Ví dụ, đặt thông báo cảnh báo hoặc nguy hiểm. just before hoặc ngay sau đó thảo luận về một bước mà độc giả có thể làm tổn thương bản thân.
- Tránh có quá nhiều thông báo đặc biệt tại bất kỳ thời điểm nào trong văn bản. Nếu không, hiệu quả của định dạng đặc biệt của chúng sẽ bị mất. (Nếu bạn có quá nhiều, hãy kết hợp chúng.)
- Với các cảnh báo, sự chú ý và thông báo nguy hiểm, hãy giải thích hậu quả của việc không chú ý đến thông báo. Nêu rõ những gì sẽ xảy ra nếu người đọc không tuân theo thông báo.
- Các ví dụ trong phần này sử dụng in đậm. Tránh sử dụng chữ in hoa cho nội dung của bất kỳ thông báo đặc biệt nào.
Ghi chú: Trong một khu vực xuất bản được thiết lập đúng cách, các nhà văn kỹ thuật sẽ không phải quyết định loại thông báo nào để sử dụng hoặc thậm chí soạn thảo ngôn ngữ thông báo. Điều đó nên là công việc của các luật sư tổ chức. Tuy nhiên, những luật sư đó có thể quá bận rộn để xem xét các thông báo của bạn, vì vậy gánh nặng có thể vẫn thuộc về bạn, nhà văn hoặc biên tập viên kỹ thuật.
Định dạng cho Thông báo Đặc biệt
Sử dụng các thông tin sau để biết chi tiết cụ thể về việc viết hoa, kiểu chữ (in đậm, gạch chân, font chữ khác nhau, kích thước chữ khác nhau) và khoảng cách cho mỗi loại thông báo đặc biệt.
Ghi chú
Sử dụng định dạng sau cho ghi chú đơn giản:
- Gõ nhãn "Ghi chú" theo sau bằng dấu hai chấm. (Mặc dù một số ví dụ sau sử dụng in đậm, nhưng ưu tiên in nghiêng để tránh nhầm lẫn thị giác với tiêu đề.)
- Bắt đầu gõ nội dung của ghi chú cách một khoảng sau dấu hai chấm. (Nhưng đừng đặt nội dung của ghi chú ở dạng in đậm hoặc in nghiêng.)
- Để khoảng cách đơn trong văn bản của ghi chú; bỏ qua một dòng trên và dưới ghi chú.
- Bắt đầu các dòng chạy đè lên bên lề trái thông thường.
- Căn chỉnh ghi chú với văn bản mà nó tham chiếu (như minh họa trong ví dụ thứ hai).
Ví dụ về một ghi chú đơn giản
Ví dụ về một ghi chú trong danh sách có dấu đầu dòng (không phải văn bản chạy thông thường). Nguyên tắc này (rằng các thông báo đặc biệt liên quan đến văn bản mà chúng đề cập) cũng áp dụng cho các loại thông báo đặc biệt khác.
Ghi chú
Sử dụng định dạng sau cho nhiều ghi chú:
- Sử dụng định dạng này khi bạn có quá nhiều ghi chú mà việc trình bày từng cái sẽ gây phân tâm.
- Gõ nhãn "Ghi chú" theo sau bởi dấu hai chấm. (Mặc dù một số ví dụ sau đây sử dụng chữ in đậm, hãy ưu tiên chữ nghiêng để tránh nhầm lẫn thị giác với tiêu đề.)
- 1. Sử dụng danh sách đánh số cho các ghi chú cá nhân; trong đó, tuân theo quy tắc cho danh sách đánh số. 2. (Không sử dụng chữ in đậm hoặc chữ in nghiêng cho các ghi chú cá nhân.)
- Căn chỉnh các ghi chú với văn bản mà chúng đề cập; bỏ qua tương đương một dòng phía trên và phía dưới các ghi chú.
Ví dụ về một nhiều ghi chú. Sử dụng định dạng này nếu bạn có nhiều ghi chú và muốn thu thập tất cả chúng ở một nơi để tránh phân tâm.
Cảnh báo
Sử dụng định dạng sau cho các thông báo cảnh báo:
- **"Caution":**
- Bỏ qua một dòng và bắt đầu văn bản cảnh báo thẳng hàng với vị trí bắt đầu của nhãn cảnh báo.
- Cảnh báo: Vui lòng không sử dụng sản phẩm này nếu bạn có dị ứng với bất kỳ thành phần nào trong đó. Sử dụng sản phẩm này theo hướng dẫn và không vượt quá liều lượng khuyến cáo.
- Căn chỉnh thông báo cảnh báo với văn bản mà nó tham chiếu đến (trong đoạn trước, thông báo cảnh báo xuất hiện trong một danh sách đánh số và được thụt lề tương ứng).
Ví dụ về thông báo cảnh báo. Sử dụng cái này để cảnh báo người đọc về khả năng thiệt hại thiết bị hoặc vấn đề với quy trình.
Cảnh báo
Sử dụng định dạng sau cho các cảnh báo:
- Gõ nhãn "Cảnh báo," in nghiêng, và theo sau là dấu hai chấm.
- Bấm tab đến đầu văn bản của cảnh báo, hoặc sử dụng định dạng thụt hiện (cái này tốt hơn nhiều). Định dạng thụt hiện cho cảnh báo trong ví dụ dưới đây sử dụng 0,63 inch cho cả tab và thụt hiện, nhưng kích thước phông chữ sẽ khiến giá trị này thay đổi.
Ghi chú: Xem Tạo một đoạn thụt lề treo cho một video về cách tạo định dạng thụt đầu dòng treo trong Microsoft Word.
- Sử dụng phông chữ cơ bản cho văn bản của thông báo cảnh báo (không đậm, không nghiêng, không in hoa, không màu).
- Căn chỉnh thông báo cảnh báo với văn bản mà nó đề cập đến.
- Bỏ qua tương đương một dòng phía trên và phía dưới thông báo cảnh báo.
Ví dụ về một thông báo cảnh báo. Sử dụng cái này để cảnh báo người đọc về khả năng bị thương nhẹ.
Nguy hiểm
Sử dụng định dạng sau cho thông báo nguy hiểm:
- **"DANGER"**
- Căn chỉnh thông báo nguy hiểm với văn bản mà nó đề cập đến.
- Tách đơn khoảng cách của văn bản thông báo nguy hiểm; bỏ qua một dòng ở trên và dưới thông báo nguy hiểm.
- Sử dụng chữ đậm cho văn bản của thông báo nguy hiểm nếu bạn có (nhưng không bao giờ viết hoa tất cả).
- Nếu bạn có khả năng đồ họa, hãy vẽ một hộp xung quanh thông báo nguy hiểm (bao gồm cả nhãn).
Thông báo nguy hiểm. Sử dụng cái này để cảnh báo độc giả về khả năng bị thương nặng hoặc tử vong.
Hình ảnh Thông báo (Biểu tượng)
Vui lòng xem hình ảnh thông báo chung.
Các vấn đề định dạng khác
Dưới đây là một số điểm bổ sung cần xem xét liên quan đến thông báo đặc biệt:
Căn chỉnh đặc biệt. Các thông báo đặc biệt phải được căn chỉnh với văn bản mà chúng đề cập. Ví dụ, nếu bạn có một ghi chú bổ sung chi tiết đặc biệt cho một mục trong danh sách có dấu đầu dòng, bạn phải căn chỉnh ghi chú đó với văn bản của mục đã đánh dấu. Tất nhiên, nếu ghi chú theo sau một danh sách đã đánh dấu nhưng đề cập đến toàn bộ danh sách, thì bạn có thể sử dụng lề trái thông thường.
Văn bản đơn lề. Tất cả các ví dụ và thảo luận trong đơn vị này đều dựa trên văn bản đơn khoảng cách. Để lại một dòng trống giữa văn bản chạy và các thông báo đặc biệt—tùy thuộc vào cái gì trông đẹp nhất với bạn. (Và tất nhiên cả văn bản chạy và văn bản của các thông báo đặc biệt đều sẽ là đơn khoảng cách.)
Đặt các thông báo đặc biệt. Đặt thông báo đặc biệt ngay trước khi hoặc ngay sau đó điểm mà chúng liên quan. Ví dụ, bạn có thể cảnh báo người đọc sao lưu tất cả dữ liệu. trước khi Bạn bảo họ định dạng lại ổ cứng của mình. Tuy nhiên, trên thực tế, những thông báo đặc biệt nghiêm trọng thường được đặt ở phần đầu của quy trình, nơi có khả năng gây hại lớn cho dữ liệu, thiết bị hoặc con người.
Một kỹ thuật được sử dụng bởi những nhà văn rất cẩn thận (có thể là những người đã từng bị ảnh hưởng) là đặt tất cả các thông báo nghiêm trọng (cảnh báo, lưu ý và nguy hiểm) ở đâu đó tại phần đầu của tài liệu, và sau đó lặp lại chúng một cách riêng lẻ nơi mà chúng áp dụng. Một tổ chức có thể có một hướng dẫn về phong cách mà nêu rõ các yêu cầu về vị trí của các thông báo.
Biểu đồ ý nghĩa thông báo đặc biệt. Hướng dẫn sử dụng thường đặt một bảng biểu cho ý nghĩa của các loại thông báo khác nhau trong phần giới thiệu, như được minh họa một phần ở đáy hình này. Lưu ý rằng trong ví dụ này không có loại thông báo cảnh báo, chỉ minh họa cách mà các thông báo khác nhau trong các ngành:
Biểu đồ thông báo. Lưu ý trong ví dụ này không có loại thông báo cảnh báo, minh họa cách mà các thông báo khác nhau giữa các ngành.
Nhiều thông báo đặc biệt. Bạn sẽ gặp phải các tình huống mà bạn có ba hoặc bốn thông báo đặc biệt, tất cả đều xếp chồng lên nhau trong cùng một phần của văn bản, mỗi cái theo sau cái kia. Đây là một vấn đề vì toàn bộ mục đích của việc định dạng đặc biệt các thông báo bị mất: cái gì đó là đặc biệt vì nó khác với các phần xung quanh. Giải pháp cho vấn đề này là tạo ra một tiêu đề nhận diện (ví dụ, "Ghi chú và Cảnh báo"), và sau đó liệt kê các thông báo (hoặc theo dạng gạch đầu dòng hoặc theo số) bên dưới nó.
Thông tin liên quan
Định nghĩa ANSI cho biển báo Nguy hiểm, Cảnh báo, Thận trọng hoặc Thông báo. Bao gồm hình ảnh có thể tải xuống.
1910.145 - Đặc điểm kỹ thuật cho biển báo và nhãn hiệu phòng ngừa tai nạn. OSHA
Các loại biển báo an toàn OSHA (50487). Nhiều hình ảnh có thể tải xuống.
Các màu sắc khác nhau của biển báo an toàn có nghĩa gì?. bao gồm hình ảnh có thể tải xuống. Cung cấp an toàn sáng tạo
Tại sao hình ảnh nhấp nháy "12:00" trở thành biểu tượng tối thượng của sự thất vọng về công nghệ những năm 90. Sydney Butler, howtogeek.com
Tôi rất mong nhận được ý kiến, phản ứng, và phê bình của bạn về chương này: phản hồi của bạn—David McMurrey.
