Thông báo đặc biệt là một đặc điểm quan trọng trong 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, để thực hiện 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 chính họ hoặc người khác.
Thông báo rất đặc biệt. Thông báo tiên tiến 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 phong cách thông báo cụ thể. Cần chú ý rằng còn nhiều phong cách và định dạng khác tồn tại.
- Sử dụng thông báo đặc biệt để nhấn mạnh những điểm quan trọng hoặc cảnh báo, nhắc nhở người đọc về nguy cơ hư 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, cho các 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 những vấn đề nhỏ trong một quy trình.
Cảnh giác—Cảnh báo người đọc về khả năng hư 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 (chẳng hạn như sự xấu hổ).
Cảnh báo—Cảnh báo độc giả 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 độc giả về khả năng bị thương nghiêm trọng hoặc tử vong đối với bản thân hoặc người khác.
Lưu ý: Hãy nhìn xung quanh gara hoặc bếp của bạn, và chú ý đến những thông báo đặc biệt bạn thấy trên các sản phẩm. Bạn sẽ thấy rất nhiều sự khác biệt, điều này có thể phụ thuộc vào tiêu chuẩn cụ thể của ngành hoặc doanh nghiệp.
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 là phù hợp hơn (cũng giống như "kêu gọi khẩn cấp"). Ngoài ra, sử dụng thông báo một cách nhất quán trong toàn bộ tài liệu. Làm 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 thông báo đặc biệt tại các điểm trong văn bản nơi cần thiết. Ví dụ, đặt thông báo cảnh báo hoặc nguy hiểm. ngay trước khi 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ỳ đ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 lại.)
- Cảnh báo, thận trọng và thông báo nguy hiểm: giải thích hậu quả của việc không chú ý đến thông báo. Nêu rõ điều gì sẽ xảy ra nếu người đọc không chú ý đến thông báo.
- Các ví dụ trong phần này sử dụng chữ in đậm. Tránh sử dụng chữ viết hoa hoàn toàn cho văn bản của bất kỳ thông báo đặc biệt nào.
Chú ý: Trong một khu vực xuất bản được thiết lập đúng cách, các nhà viết 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 nội dung thông báo. Điều đó nên là trách nhiệm của các luật sư trong tổ chức. Tuy nhiên, các 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 rơi vào bạn, là nhà viết kỹ thuật hoặc biên tập viên.
Định dạng cho Thông báo Đặc biệt
Sử dụng các thông tin sau cho các chi tiết cụ thể về việc viết hoa, kiểu chữ (in đậm, gạch chân, phông chữ khác nhau, kích thước loại 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ở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 về hình thức với tiêu đề.)
- Bắt đầu gõ nội dung ghi chú cách một khoảng trống sau dấu hai chấm. (Nhưng không đặt nội dung ghi chú trong chữ đậm hoặc 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ề trái bình thường.
- Căn chỉnh ghi chú với văn bản mà nó đề cập đến (như được 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 gạch đầ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ụ dưới đây sử dụng chữ in đậm, ưu tiên sử dụng chữ in nghiêng để tránh nhầm lẫn thị giác với tiêu đề.)
- 1. Sử dụng danh sách có đánh số cho từng lưu ý. 2. Trong đó, tuân theo các quy tắc của danh sách có đánh số. 3. (Không sử dụng chữ đậm hoặc chữ nghiêng cho từng lưu ý.)
- Căn chỉnh các ghi chú với văn bản mà chúng ám chỉ; bỏ qua tương đương của một dòng ở trên và dưới các ghi chú.
Ví dụ về một ghi chú nhiều mục. Sử dụng định dạng này nếu bạn có nhiều ghi chú và muốn tập hợp chúng lại một nơi để tránh phân tâm.
Cảnh giác
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 phần văn bản của cảnh báo căn chỉnh với điểm bắt đầu của nhãn cảnh báo.
- Cảnh báo: Xin hãy cẩn thận khi sử dụng thiết bị này. Nếu có bất kỳ vấn đề nào, hãy liên hệ với bộ phận hỗ trợ kỹ thuật.
- Căn chỉnh thông báo cảnh báo với văn bản mà nó đề cập đến (trong phầ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ẩn thận. Sử dụng cái này để thông báo cho người đọc về khả năng hư 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 bằng dấu двỗ ":" .
- Chọn hoặc là thụt lề vào đầu văn bản của cảnh báo, hoặc sử dụng định dạng thụt lề treo (cái này tốt hơn nhiều). Định dạng thụt lề treo cho cảnh báo trong ví dụ dưới đây sử dụng 0.63 inch cho cả thụt lề và thụt lề treo, nhưng kích thước phông sẽ làm 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 lề treo trong Microsoft Word.
- Sử dụng phông chữ thông thường cho văn bản của thông báo cảnh báo (không đậm, không nghiêng, không viết hoa tất cả, 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 các dòng tương đương một dòng bên trên và bên dưới thông báo cảnh báo.
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 chấn 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.
- Đơn giản hóa khoảng cách giữa các dòng của thông báo nguy hiểm; bỏ qua một dòng ở trên và một dòng ở dưới thông báo nguy hiểm.
- **Sử dụng đậ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 tất cả bằng chữ in hoa).**
- Nếu bạn có khả năng đồ họa, hãy vẽ một cái 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 điều này để cảnh báo độc giả về khả năng bị chấn thương nghiêm trọng hoặc tử vong.
Hình ảnh Thông báo (Biểu tượng)
Xin vui lòng xem hình ảnh thông báo chung.
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ăn chỉnh với văn bản mà chúng tham chiếu. Ví dụ, nếu bạn có một ghi chú thêm một số chi tiết đặc biệt vào một mục trong danh sách gạch đầu dòng, bạn phải căn chỉnh ghi chú đó với Văn bản của mục được đánh dấu. Tất nhiên, nếu ghi chú theo sau một danh sách được đá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 bình thường.
Văn bản đơn gian cách. 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 cách dòng đơn. Để lại một dòng trống giữa văn bản chạy và thông báo đặc biệt—tùy thuộc vào những 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ẽ cách dòng đơn.)
Đặt thông báo đặc biệt. Đặt thông báo đặc biệt ngay trước khi hoặc ngay sau đó thời điểm mà chúng có 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 Bạn nói với họ để định dạng lại ổ cứng của họ. Tuy nhiên, trên thực tế, các thông báo đặc biệt nghiêm trọng thường được đặt ngay ở đầu quy trình, nơi có khả năng gây ra thiệt 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 đã gặp rắc rối) là đặt tất cả các thông báo nghiêm túc (cảnh báo, lưu ý và nguy hiểm) ở đâu đó ở đầu tài liệu, và sau đó lặp lại chúng từng cái một nơi chúng áp dụng. Một tổ chức có thể có một hướng dẫn phong cách quy định yêu cầu về vị trí của các thông báo.
Biểu đồ các ý nghĩa thông báo đặc biệt. Hướng dẫn người dùng thường đặt một bảng cho ý nghĩa của các loại thông báo khác nhau trong phần prefac, như được minh họa một phần ở dưới 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 theo 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 thức 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 những tình huống mà bạn có ba hoặc bốn thông báo đặc biệt, tất cả đều chồng chéo nhau trong cùng một phần của văn bản, mỗi thông báo theo sau một thông báo khác. Đây là một vấn đề bởi vì toàn bộ mục đích của việc định dạng đặc biệt cho các thông báo đã bị mất: điều gì đó đặc biệt bởi vì nó khác biệt so với những thứ xung quanh. Giải pháp cho vấn đề này là tạo một tiêu đề nhận dạng (ví dụ, "Ghi chú và Cảnh báo"), và sau đó liệt kê các thông báo (hoặc đánh dấu hoặc đánh số) 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à thẻ ngăn ngừa tai nạn. OSHA
Các danh mục biển báo an toàn OSHA (50487). Nhiều hình ảnh có thể tải xuống.
Các màu 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. Công ty 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 công nghệ những năm 90. Sydney Butler, howtogeek.com
Tôi rất trân trọng những suy nghĩ, 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.
