Nổi bật, như thuật ngữ được sử dụng ở đây, là việc sử dụng các hiệu ứng chữ viết để thu hút sự chú ý đến văn bản. Các hiệu ứng này có thể bao gồm chữ nghiêng, chữ đậm, chữ in hoa, dấu ngoặc kép, màu sắc, và nhiều hơn nữa. Việc làm nổi bật thu hút sự chú ý của độc giả—hoặc "gợi ý" —cho họ những hành động họ phải thực hiện hoặc thông tin họ cần cân nhắc kỹ lưỡng.

Một trong những vấn đề trong viết kỹ thuật—cụ thể, viết kỹ thuật về máy tính—liên quan đến việc sử dụng các kỹ thuật khác nhau để nhấn mạnh. Thật không may, một số văn bản kỹ thuật lạm dụng việc sử dụng các kỹ thuật nhấn mạnh khác nhau được thảo luận ở đây.

Nổi bật các cơ bản

Xem xét một vài nguyên tắc cơ bản của sự nhấn mạnh:

Trong cuộc thảo luận sau đây, bạn sẽ nhận thấy rằng bất kỳ hệ thống kỹ thuật nhấn mạnh nào cũng có thể trở nên khá phức tạp và khó nhớ đối với các nhà văn và biên tập viên. Bạn sẽ thấy có nhiều cách sử dụng kỹ thuật nhấn mạnh hợp lệ ngang nhau: ví dụ, trong một số trường hợp, việc bạn sử dụng in đậm hay nghiêng để nhấn mạnh đơn giản là tùy ý. Để giải quyết vấn đề này, bạn phải tài liệu hóa các hướng dẫn làm nổi bật của mình trong một cuốn hướng dẫn phong cách mà các nhà văn và biên tập viên (hoặc chỉ bạn) có thể tham khảo. A hướng dẫn phong cách đơn giản là một bản ghi lại các quyết định mà bạn và nhóm tài liệu của bạn đã đưa ra về cách bạn muốn tài liệu của mình trông như thế nào.

Người đọc của bạn cũng cần được thông báo về sơ đồ làm nổi bật mà bạn dự định sử dụng. Điều này có thể được xử lý trong phần lời nói đầu: bao gồm một phần có tên là "Làm nổi bật" hoặc "Quy tắc kiểu chữ" nơi bạn liệt kê cách bạn sử dụng chữ italics, chữ đậm, các phông chữ, và những hiệu ứng như vậy. Để lấy ví dụ, xem thảo luận về lời nói đầu trong chương về các thành phần tiêu chuẩn của sách kỹ thuật

Kỹ thuật nhấn mạnh cụ thể

Phần tiếp theo sẽ đi qua từng kỹ thuật nhấn mạnh, giải thích các phương pháp chung.

Ghi chú: Để giữ mọi thứ đơn giản, nhấn mạnh các vấn đề cho bàn, hình ảnh, tiêu đề, danh sách, và thông báo được trình bày trong các phần đó.

Đậm

Trong xuất bản, đặc biệt là xuất bản kỹ thuật, có sự pha trộn về việc nên sử dụng in đậm hay in nghiêng để nhấn mạnh cơ bản. Ví dụ, nếu bạn muốn nhấn mạnh rằng người đọc không nên tắt máy tính mà không tắt nó trước, từ "không" có thể được in đậm hoặc in nghiêng. Truyền thống thì in nghiêng đã được sử dụng, nhưng có lẽ vì lý do máy tính, in đậm cũng thường được sử dụng.

Kỹ thuật nào bạn sử dụng, hãy sử dụng một cách nhất quán trong toàn bộ văn bản hoặc thư viện các văn bản liên quan của bạn. Nhân tiện, độc giả không có khả năng phân biệt được các mức độ nhấn mạnh: ví dụ, việc sử dụng chữ nghiêng cho văn bản quan trọng và chữ đậm cho văn bản rất quan trọng có thể sẽ bị hầu hết độc giả bỏ qua.

Nếu bạn bị cám dỗ để làm tất cả một đoạn văn thành chữ đậm, hãy nhớ một trong những nguyên tắc nhấn mạnh đã được thảo luận ở trên: sử dụng quá nhiều kỹ thuật nhấn mạnh sẽ làm mất đi hiệu quả của kỹ thuật đó. Không những vậy, quá nhiều nhấn mạnh làm cho người đọc kém hứng thú hơn với việc đọc. Thay vì đọc kỹ một đoạn văn toàn chữ đậm, người đọc có thể bỏ qua nó hoàn toàn!

Thay vì tạo một đoạn văn hoàn toàn in đậm, hãy sử dụng định dạng thông báo đặc biệt. Trong đó, một từ khóa (ví dụ: Quan trọng, Lưu ý, Nguy hiểm, Thận trọng, Cảnh báo) được in đậm, trong khi phần còn lại của văn bản được để ở dạng chữ thường (tức là, cùng kiểu chữ và phong cách như văn bản chính).

Việc sử dụng in đậm hợp pháp trong các văn bản kỹ thuật thay đổi rất nhiều. Miễn là bạn phát triển một sơ đồ liên quan trực tiếp đến nhu cầu của người đọc và đặc điểm của văn bản (hoặc công nghệ) và không dẫn đến việc sử dụng quá mức, việc sử dụng in đậm của bạn sẽ hoạt động tốt.

Dưới đây là một số cách sử dụng chữ đậm thông dụng, tiêu chuẩn:

Bạn sẽ nhận thấy rằng cuộc thảo luận trước đó không nêu ra quy tắc tuyệt đối nào. Đó là cách mà thực hành xuất bản kỹ thuật khá đa dạng. Ý tưởng chính là phát triển một hệ thống làm nổi bật hợp lý, có kiểm soát, sử dụng nó một cách nhất quán, và ghi lại nó trong một hướng dẫn phong cách để bạn và các thành viên trong nhóm tài liệu của bạn có thể tham khảo.

Nghiêng

Dưới đây là một số cách sử dụng chữ nghiêng tiêu chuẩn:

Gạch chân

Hầu như không có lý do nào để sử dụng dấu gạch chân trong văn bản kỹ thuật. Trong thời kỳ văn bản đánh máy, chắc chắn điều đó là cần thiết. Tuy nhiên, trong thời đại này, khi chữ đậm, chữ nghiên và các hiệu ứng kiểu chữ khác đã dễ dàng có sẵn, dấu gạch chân trông thật lỗi thời. Nếu bạn muốn nhấn mạnh điều gì đó, hãy sử dụng các hướng dẫn chuẩn của bạn— ví dụ, dùng chữ nghiêng hoặc chữ đậm. Đừng cố gắng tạo ra các mức độ nhấn mạnh: ví dụ, một thang độ quan trọng tăng dần từ chữ nghiêng đến chữ đậm rồi đến dấu gạch chân sẽ không được người đọc hiểu.

Nếu bạn thấy sự sử dụng dấu gạch dưới một cách hợp lý trong văn bản kỹ thuật, nó có thể xảy ra trong thiết kế tiêu đề.

Chữ hoa

Trong xuất bản kỹ thuật, dường như có một cuộc chiến liên tục giữa các nhà viết kỹ thuật và các chuyên gia kỹ thuật về việc viết hoa. Các chuyên gia kỹ thuật thích sử dụng chữ cái đầu cho gần như mọi thành phần và quy trình trong một hệ thống. Ngoài ra, các chuyên gia kỹ thuật (và ban quản lý) thường sử dụng chữ in hoa cho các văn bản mà họ coi là quan trọng và muốn người đọc chú ý đến. Trong khi đó, các nhà viết kỹ thuật và biên tập viên (một cách đúng đắn) khăng khăng rằng chỉ nên sử dụng chữ hoa cho tên riêng.

Là một nhà viết kỹ thuật, hãy giữ nguyên quy tắc chống lại việc viết hoa. Chữ hoa gây phân tâm; văn bản toàn chữ hoa thì khó đọc. Chữ hoa tạo ra một văn bản bận rộn, gửi đi nhiều tín hiệu không cần thiết. Chữ hoa thường được sử dụng cho các tên riêng như Microsoft, Netscape, Gateway, Dell Computers, WordPerfect, và vân vân. Nguyên tắc cổ điển trong xuất bản kỹ thuật là viết hoa tên của sản phẩm có thể đặt hàng riêng biệt chỉ. Tuy nhiên, chính trị của các tổ chức làm biến tướng hướng dẫn này khá nhiều. Nếu một công ty tự hào về một tính năng nhất định trong phiên bản mới của mình, chẳng hạn như EnergyMiser, họ sẽ viết hoa nó, ngay cả khi bạn không thể đặt hàng riêng.

Dưới đây là một số hướng dẫn điển hình về việc viết hoa:

Dấu nháy đơn hoặc dấu nháy đôi

Dấu ngoặc kép thường bị sử dụng nhầm như một kỹ thuật nhấn mạnh trong văn bản kỹ thuật. Là một người viết kỹ thuật, hãy giới hạn việc sử dụng dấu ngoặc kép vào những cách sử dụng truyền thống, bao gồm lời nói được trích dẫn; số, chữ cái, hoặc từ được đề cập như vậy. Dấu ngoặc kép, giống như chữ hoa, có xu hướng tạo ra một văn bản bận rộn, gây phân tâm và do đó nên được tránh.

Một cách sử dụng hợp lệ của dấu ngoặc kép là việc sử dụng từ ngữ một cách lạ lùng, kỳ quặc, không chuẩn (được gọi là "dấu ngoặc sợ hãi" bởi Hướng Dẫn Chicago về Phong Cách). Ví dụ:

Trong một core dump, máy tính "nhả" tất cả dữ liệu vào một file duy nhất.

Văn bản máy tính được thiết kế tốt tránh sử dụng dấu ngoặc kép một cách mạnh mẽ. Một trong những lý do chính là một số độc giả có thể nhầm tưởng rằng họ phải bao gồm các dấu ngoặc kép trong các lệnh họ nhập.

Thay vì Sử dụng lệnh "di chuyển".
Viết Sử dụng di chuyển lệnh.
Thay vì Nhập "copy install installnow."
Viết Nhập vào sao chép cài đặt cài đặt ngay bây giờ

Chú ý: Trong khi một số văn bản kỹ thuật có cách sử dụng được xác định rõ ràng cho dấu nháy đơn, nói chung, không có quy tắc tiêu chuẩn nào cho dấu nháy đơn, ngoài quy tắc trích dẫn-trong-một-trích dẫn truyền thống và quy tắc sử dụng kỳ quặc. Khi bạn thấy dấu nháy đơn trong văn bản kỹ thuật, thường thì không có lý do nhiều hơn cho việc sử dụng chúng so với dấu nháy kép.

Phông chữ thay thế

Một trong những phong cách phổ biến nhất liên quan đến việc sử dụng phông chữ thay thế là sử dụng Courier hoặc một phông chữ kiểu máy đánh chữ cũ tương tự, tương phản với phông chữ thân tiêu chuẩn (như Times New Roman hoặc Helvetica). Bạn có thể tạo hiệu ứng này trên một trang web bằng cách sử dụng một kiểu CSS như <span class="example_text">. Ví dụ, "type cài đặt để cài đặt chương trình."

Đây là một bài đánh giá về các ứng dụng phổ biến của các phông chữ thay thế:

Màu sắc

Màu sắc được sử dụng trong văn bản kỹ thuật nhưng nó tốn kém và khó quản lý trong quá trình xuất bản.

Tuy nhiên, màu sắc rất dễ sử dụng trong thông tin trực tuyến. Thường thấy các liên kết siêu văn bản, chẳng hạn, sử dụng màu sắc. Các trang trợ giúp trực tuyến thường dùng màu xanh lá cây trong khi các trang web thường sử dụng màu xanh dương cho các liên kết mới và màu tím cho các liên kết mà người dùng đã khám phá trước đó.

Xu hướng sử dụng màu sắc một cách bừa bãi trong thông tin trực tuyến giống như xu hướng sử dụng đậm, nghiêng, kích cỡ phông chữ và các kiểu chữ khác nhau trong thông tin in ấn. Cảm giác phải giống như, "Nó đang ở đây, nó thật ngầu, vậy hãy sử dụng nó!"

Nếu bạn muốn sử dụng màu sắc, hãy lên kế hoạch cẩn thận. Đừng mong độc giả nhớ rằng màu đỏ biểu thị một ý tưởng, màu xanh biểu thị một ý tưởng khác, và màu xanh lá cây biểu thị một ý tưởng khác nữa. Hãy chỉ sử dụng một màu. Nói chung, tránh sử dụng màu sắc cho văn bản dài. Thay vì làm toàn bộ thông báo cảnh báo màu đỏ, chỉ cần làm nhãn Cảnh báo màu đỏ và để văn bản cảnh báo ở định dạng chữ thường (văn bản giống như văn bản cơ bản).

Tốt hơn nữa, hãy đọc một số tài liệu tiêu chuẩn về màu sắc trong lĩnh vực truyền thông kỹ thuật. Có các vấn đề thiết kế chung và các vấn đề quốc tế:

Các tổ hợp của những điều đã nêu trên

Nói chung, việc kết hợp các kỹ thuật nhấn mạnh là một ý tưởng tồi, ví dụ như in đậm và nghiêng. Trong văn bản kỹ thuật không chuyên nghiệp, bạn sẽ thấy những sự kết hợp sặc sỡ như in đậm-nghiêng tất cả chữ in hoa hoặc in đậm-nghiêng tất cả chữ in hoa với dấu ngoặc kép kép. Tránh những điều này!

Một cách kết hợp hợp lệ là sử dụng chữ nghiêng với các phông chữ khác nhau. Ví dụ, khi bạn hiển thị cú pháp của một lệnh, bạn muốn toàn bộ văn bản được in bằng phông Courier, nhưng bạn cũng muốn các biến được in nghiêng:

sao chép TênTệpCũ TênTệpMới

Tên chức năng cho kiểu nhân vật và thẻ

Nếu bạn từng ở trong ngành xuất bản, bạn có thể đã gặp một cái gọi là đánh dấu ngữ nghĩa. Điều này có nghĩa là đặt tên các phần của văn bản theo vai trò cấu trúc mà chúng đảm nhận trong tài liệu — ví dụ, tiêu đề. Người đọc không thấy những tên này, nhưng chúng đóng vai trò quan trọng trong cách tài liệu được định dạng và cách nó có thể được sử dụng lại.

Ý tưởng tương tự áp dụng cho các từ trong cụm từ within văn bản. Ví dụ, trong HTML cho một trang web, bạn có thể sử dụng <b>từ được in đậm</b> các thẻ để làm cho một từ đậm. Nhưng độ đậm không chỉ ra chức năng của từ hoặc cụm từ. Thay vào đó, lệnh sẽ hoặc nhãn_giao_diện do đó. Vì vậy, trong đánh dấu ngữ nghĩa sử dụng HTML CSS, mọi thứ hoạt động tốt hơn nếu chúng trông như thế này: <span class="command">từ được in đậm</span>.

Các tệp sử dụng HTML và CSS thường được chuyển đổi sang các phương tiện khác như PDF hoặc thậm chí từ và đến XML. Sử dụng chức năng Các kiểu đánh dấu tên, như đã mô tả ở trên, có thể greatly giúp dễ dàng quá trình chuyển đổi.

Khám Phá Tiếp Theo

Khi bạn đã đọc xong phần trước, một điều tốt để làm tiếp theo là khám phá các ấn phẩm kỹ thuật để xem họ sử dụng các sơ đồ nhấn mạnh như thế nào. Hãy chú ý đến cách mà các hiệu ứng như chữ đậm, chữ italics, chữ viết hoa, phông chữ khác nhau và những hiệu ứng tương tự được sử dụng. Có khả năng cao là bạn sẽ thấy cách sử dụng rất khác so với những gì bạn đã đọc ở đây. Khi bạn khám phá, hãy nghĩ về logic của các kỹ thuật nhấn mạnh mà bạn thấy được sử dụng; cố gắng xây dựng các quy tắc mà các nhà văn dường như đang sử dụng; theo dõi những không nhất quán trong việc nhấn mạnh; và suy nghĩ một cách lập luận về cách sử dụng mà bạn thấy — có hợp lý không? Thừa thãi? "Thiếu thốn?"

Sau khi bạn đã khám phá như vậy, bước hợp lý tiếp theo là đọc chương về hướng dẫn phong cách, nếu bạn chưa làm điều đó. Các sơ đồ đánh dấu phải được ghi chép trong hướng dẫn phong cách để bạn không quên chúng và để các thành viên trong nhóm tài liệu của bạn có thể tham khảo.

Sơ đồ Nhấn mạnh

Nếu tất cả các tùy chọn và lựa chọn đã được thảo luận trước đó khiến bạn choáng ngợp, hãy cân nhắc sử dụng sơ đồ làm nổi bật sau đây. Nó dựa trên cách làm nổi bật mà bạn sẽ tìm thấy trong nhiều tài liệu UNIX, Windows và Linux.

Tên của các trường, thư mục, hộp thoại (hộp), menu (bất kỳ đối tượng giao diện nào mà người dùng thực hiện không nhấn vào) Kiểu chữ trên màn hình; chữ La Mã thường
Tên các biểu tượng Phong cách chữ in đậm trên màn hình; đậm.
Nút (hoặc tương đương chức năng nếu không được ghi nhãn như vậy) Kiểu chữ in đậm trên màn hình; in đậm
Lựa chọn menu, tùy chọn có thể chọn Phong cách chữ in trên màn hình; đậm
Các lệnh được nhập chính xác mà không có tham số hoặc cờ. In đậm
Văn bản được nhập hoặc hiển thị Courier New (nếu cần, nhỏ hơn 1 điểm so với phông chữ chính)
Biến số Nghiêng; chữ roman thường
Mã lập trình Courier New; chữ thường; nếu cần, nhỏ hơn 1 điểm so với phông chữ chính
Nhãn trên phần cứng Courier New; đậm; nếu cần, nhỏ hơn 1 điểm so với phông chữ cơ thể

  • Ghi chú:

    1. Chữ La Mã thường xuyên đề cập đến bất cứ kiểu chữ và kích thước chữ nào được sử dụng cho văn bản chính.
    2. Trong khi những gợi ý này khuyên "kiểu chữ in hoa trên màn hình," các nhà phát triển đôi khi có xu hướng không may là sử dụng chữ in hoa toàn bộ. Bởi vì việc sử dụng kiểu chữ in hoa toàn bộ làm giảm khả năng đọc, hãy sử dụng chữ in hoa đầu (kiểu tiêu đề) thay vì vậy.
    3. Nếu bạn chỉ cho người dùng cách nhập một lệnh bao gồm văn bản ví dụ, đừng in đậm lệnh xuất hiện trong văn bản ví dụ:
    4. Sử dụng mv lệnh để thay đổi tên vị trí của một file, ví dụ:
      di chuyển thisfile.txt thành thatfile.txt.

    5. Nếu bạn hướng dẫn người dùng cách nhập một lệnh bao gồm văn bản ví dụ, và bao gồm các biến trong văn bản ví dụ, hãy sử dụng chữ nghiêng cho các biến.
    6. Sử dụng mv lệnh để thay đổi tên hoặc vị trí của một tệp:
      mv tệp_của_tôi.txt tệp_của_bạn.txt.

    7. Nếu bạn chỉ đề cập đến tên của một màn hình hoặc menu mà không được nhấp vào hoặc khởi tạo bất kỳ sự kiện nào, hãy sử dụng kiểu chữ in hoa cho màn hình và chữ la-tinh thông thường.
    8. Một số phong cách làm nổi bật hành động mà người dùng cần thực hiện (ví dụ, báo chí, nhập, xóa). Đó chắc chắn là một lựa chọn, nhưng đối với tôi thì nó quá nhiều điểm nhấn.

    Các hướng dẫn sử dụng thường đặt một bảng biểu cho ý nghĩa của việc làm nổi bật font chữ, màu sắc và kiểu chữ trong phần mở đầu:

    Highlighting chart


    Tôi rất mong nhận được ý kiến, phản ứng, phê bình của bạn về chương này: phản hồi của bạn.