Thiết kế trang có ý nghĩa khác nhau đối với từng người, nhưng ở đây nó sẽ có nghĩa là việc sử dụng kiểu chữ và định dạng như bạn thấy trong các tài liệu được thiết kế chuyên nghiệp.
Chúng tôi tập trung vào tài liệu kỹ thuật, điều này ngụ ý thiết kế khiêm tốn, chức năng.
Để biết thêm chi tiết hơn những gì bạn thấy ở đây, hãy tham khảo hai nguồn tài nguyên tiêu chuẩn trong ngành này:
- Tài liệu Kỹ thuật của Sun. Đọc Tôi Trước! Bất kỳ ấn bản gần đây nào. Prentice Hall.
- Công ty TNHH Microsoft. Tài liệu Hướng dẫn Phong cách của Microsoft cho các Ấn phẩm Kỹ thuật. Bất kỳ ấn bản gần đây nào. Microsoft Press.
Đầu trang và Chân trang
Mọi người thường nhầm lẫn giữa tiêu đề và tiêu đề phụ. Tiêu đề, được đề cập trong tiêu đề những cụm từ đó có xảy ra không trong khu vực cơ thể của một tài liệu. Đầu đề là những cụm từ và có thể là số trang xuất hiện trong khu vực tiêu đề của một tài liệu. Chân trang là những cụm từ và có thể là số trang xuất hiện trong khu vực chân trang của một tài liệu. Một sai lầm phổ biến, và là một sai lầm lớn, là đặt tiêu đề của tài liệu ở khu vực đầu trang, điều này khiến nó xuất hiện ở đầu mỗi trang tiếp theo.
Xem xét một sơ đồ của một trang tài liệu điển hình:
Một thiết kế trang phổ biến là đặt tiêu đề tài liệu và số trang ở khu vực chân trang. Trong định dạng luân phiên, trang bên trái có thể hiển thị số trang và tiêu đề tài liệu, theo thứ tự đó; trang bên phải có thể hiển thị tiêu đề tài liệu và số trang, theo thứ tự đó.
Tiêu đề
Các hướng dẫn tiêu chuẩn về tiêu đề được trình bày như sau. Để thảo luận chi tiết hơn, xem chương về tiêu đề trong sách giáo trình trực tuyến.
- Sử dụng tự do các tiêu đề, có thể một tiêu đề cho mỗi hai đến ba đoạn. Dĩ nhiên, tiêu đề có thể bị lạm dụng: nhiều tiêu đề với chỉ một hoặc hai câu cho mỗi tiêu đề thì không hiệu quả.
- Thiết kế tiêu đề sao cho chúng rõ ràng chỉ ra cấp độ của chúng. Sử dụng kích thước phông chữ, kiểu phông chữ, màu sắc, đậm, nghiêng, căn chỉnh theo cách mà cấp độ của tiêu đề trở nên rõ ràng. ("Cấp độ" của tiêu đề giống như cấp độ trong một dàn bài: cấp độ đầu tiên tương ứng với số La Mã; cấp độ thứ hai, với chữ cái in hoa; và cứ như vậy.)
- Làm cho các tiêu đề mô tả rõ ràng về các phần mà chúng giới thiệu. Các tiêu đề như "Nền tảng Kỹ thuật" không cung cấp thông tin gì cho ai.
- Tạo tiêu đề song song Trong cách diễn đạt. Sự song song gửi đến người đọc những manh mối quan trọng về việc đoạn này có tương tự với các đoạn trước không.
- Tránh "đầu đề đơn lẻ"—đó là khái niệm tương tự như có "A" mà không có "B" hoặc "1" mà không có "2" trong các đề mục.
- Tránh "đầu đề chồng chéo" đó là hai hoặc nhiều đầu đề liên tiếp mà không có văn bản ở giữa.
- Tránh sử dụng đại từ khi đề cập đến tiêu đề trong văn bản theo sau tiêu đề. Nếu có một tiêu đề như "Cấu hình phần mềm," đừng theo sau nó bằng một câu như "Giai đoạn tiếp theo..."
- Xem xét việc sử dụng định dạng "đầu treo" để làm cho tiêu đề nổi bật hơn và giảm chiều dài của các dòng văn bản bình thường. Trong thiết kế đầu treo, một phần hoặc tất cả các tiêu đề nằm ở lề trái, trong khi tất cả văn bản được thụt vào từ một đến hai inch.
- Xem xét việc sử dụng tiêu đề "chạy vào" cho tiêu đề cấp thấp nhất của bạn. Thật khó để chỉ dựa vào kiểu chữ và kích thước để chỉ định các cấp độ tiêu đề. Một tiêu đề chạy vào "chạy vào" đầu của một đoạn văn và kết thúc bằng một dấu chấm. Bạn có thể sử dụng một số sự kết hợp của chữ in đậm, in nghiêng hoặc màu sắc cho những tiêu đề này.
Danh sách
Danh sách là công cụ hữu ích để nhấn mạnh những điểm quan trọng, cho phép quét văn bản nhanh chóng và cung cấp nhiều khoảng trắng hơn. Dưới đây là một số hướng dẫn chuẩn về danh sách. Để có thảo luận chi tiết hơn, xem chương về danh sách.
- Sử dụng danh sách đánh số cho những mục có thứ tự bắt buộc hoặc cần được nhắc đến theo số. Sử dụng danh sách có dấu chấm cho những mục không có thứ tự bắt buộc.
- Sử dụng định dạng danh sách đánh số và danh sách có dấu đầu dòng tiêu chuẩn có sẵn trong các kiểu đoạn của phần mềm xử lý văn bản, thẻ HTML và các loại khác.
- Làm cho cách diễn đạt của các mục trong danh sách song song.
- Giới thiệu tất cả các danh sách bằng một đoạn mở đầu; không sử dụng tiêu đề làm đoạn mở đầu cho danh sách.
- Trừ khi phong cách của tổ chức bạn ghi chú khác, hãy chấm câu các mục trong danh sách bằng dấu chấm chỉ khi chúng là câu hoàn chỉnh hoặc có các mệnh đề phụ nhúng bên trong.
- Sử dụng chữ hoa đầu câu hoặc chữ thường cho từ đầu tiên của các mục trong danh sách, nhưng phải đảm bảo sự nhất quán.
- Đối với danh sách lồng nhau, sử dụng dấu gạch ngang in đậm làm ký hiệu dấu đầu dòng cho các mục danh sách cấp hai; sử dụng chữ cái thường cho các mục danh sách đánh số cấp hai. Đảm bảo rằng các mục lồng nhau căn chỉnh đúng. văn bản hoặc cấp độ trước đó.
- Tránh việc sử dụng danh sách quá nhiều hoặc các danh sách có quá nhiều mục. Thường thì từ bảy đến mười mục được coi là tối đa cho các danh sách.
Thông báo
Thông báo là những đoạn văn bản được định dạng đặc biệt để cảnh báo người đọc về các điểm đặc biệt, ngoại lệ, vấn đề tiềm ẩn hoặc nguy hiểm. Dưới đây là một số hướng dẫn tiêu chuẩn cho thông báo. Để thảo luận chi tiết hơn, hãy xem chương về thông báo.
- Sử dụng một cấp bậc tiêu chuẩn cho các thông báo, trong đó các thông báo sẽ nổi bật và dễ nhận thấy hơn khi chúng trở nên nghiêm trọng hơn.
- Hãy xem xét việc sử dụng hệ thống phân cấp này:
- cảnh báo nguy hiểm cho các tình huống có thể gây thương tích nghiêm trọng hoặc tử vong
- cảnh báo cho các tình huống liên quan đến chấn thương nhẹ
- cảnh báo cho các tình huống liên quan đến thiệt hại thiết bị hoặc dữ liệu hoặc mối đe dọa đến sự thành công của quy trình
- ghi chú cho các điểm ngoại lệ hoặc nhấn mạnh không liên quan đến các tình huống trước đó.
- Bất kỳ kiểu thiết kế thông báo nào bạn sử dụng, hãy tránh văn bản dài được in đậm hoàn toàn, in nghiêng hoàn toàn, viết hoa hoàn toàn, hoặc các sự kết hợp của chúng.
- Ngoài việc yêu cầu độc giả làm hoặc không làm điều gì đó, hãy giải thích những gì sẽ xảy ra nếu họ phớt lờ cảnh báo, trong những điều kiện nào nên sử dụng câu nói này, và cách khôi phục nếu câu nói đó bị phớt lờ.
- Làm cho văn bản của thông báo ngắn gọn, nhưng không hy sinh sự rõ ràng. Tránh cách viết điện tín (bỏ sót các mạo từ như). a, an, cái) trong thông báo.
- Trong danh sách đánh số, căn chỉnh thông báo tới văn bản của mục trong danh sách mà chúng áp dụng cho.
- Trí tuệ chuẩn mực về việc đặt thông báo trước Bước mà vấn đề tiềm ẩn có thể gây ra sự cố trong định dạng. Nếu có thể, hãy nêu các cảnh báo, thận trọng hoặc nguy hiểm ở đầu toàn bộ quy trình.
Hình ảnh
Hình ảnh là tất cả các loại minh họa, bản vẽ, sơ đồ, ảnh và các thứ tương tự. Xem đồ họa để thảo luận chi tiết. Trong khi đó, đây là một số điểm quan trọng:
- Trong văn bản trước hình, cung cấp một tham chiếu chéo đến hình.
- Khi không nhất thiết phải bao gồm chú thích hình (tiêu đề) cho mỗi hình, nhưng khi bạn làm, hãy đặt nó dưới đây hình ảnh.
- Ví dụ, trong hướng dẫn khi các hình ảnh liên quan chặt chẽ đến từng bước, tiêu đề hình ảnh không có chức năng quan trọng và không cần thiết.
Bảng
Bảng giống như danh sách dọc, đã được thảo luận trước đó, nhưng có cấu trúc và tính chính thức hơn. Trong văn bản của bạn, hãy tìm các cặp, bộ ba hoặc bộ bốn mục lặp lại có thể được định dạng dưới dạng bảng. Ví dụ, một loạt các thuật ngữ và định nghĩa là một ứng dụng cổ điển cho bảng. Dưới đây là một số hướng dẫn tiêu chuẩn cho bảng. Để có một cuộc thảo luận chi tiết hơn, xem chương về bảng.
- Tìm các nhóm mục lặp lại trong văn bản của bạn mà bạn có thể định dạng thành bảng.
- Trong văn bản trước bảng, hãy cung cấp một tham chiếu chéo đến bảng.
- Sử dụng tiêu đề bảng trừ khi nội dung của bảng hoàn toàn rõ ràng và bảng chứa ít mục. Đặt tiêu đề bảng trên bảng, hoặc làm cho nó thành hàng đầu của bảng.
- Sử dụng tiêu đề cột và hàng (hoặc cả hai) để xác định nội dung của các cột và hàng. Hãy xem xét việc sử dụng một loại đánh dấu nào đó cho các tiêu đề cột và hàng này.
- Căn trái các cột văn bản (trừ khi chúng là các mục ký tự chữ cái đơn giản). Căn trái các cột văn bản với tiêu đề của chúng.
- Căn phải hoặc căn theo dấu thập phân dữ liệu số, và căn giữa dưới tiêu đề của nó.
- Đặt đơn vị đo lường chuẩn (ft, mm, gal.) trong tiêu đề cột hoặc hàng thay vì với từng mục trong cột hoặc hàng.
- Cung cấp một cuộc thảo luận ngắn gọn về xu hướng chính trong bảng—những gì bạn muốn người đọc chú ý.
Nổi bật
Tài liệu phần mềm thường sử dụng rất nhiều cách nhấn mạnh. Nhấn mạnh ở đây đề cập đến việc in đậm, in nghiêng, phông chữ thay thế, chữ in hoa, dấu ngoặc kép, và các thủ thuật kiểu chữ khác được sử dụng để thu hút sự chú ý đến văn bản. Dưới đây trình bày một số hướng dẫn chuẩn về cách nhấn mạnh. Để thảo luận chi tiết hơn, hãy xem chương về nhấn mạnh.
- Thiết lập một kế hoạch sử dụng việc đánh dấu, và áp dụng nó một cách nhất quán. Sử dụng việc đánh dấu cho những lý do cụ thể, chức năng. Tránh việc đánh dấu quá nhiều; tránh các sơ đồ đánh dấu phức tạp.
- Xem xét việc sử dụng sơ đồ làm nổi bật tương đối tiêu chuẩn này:
- Để nhấn mạnh một cách đơn giản, hãy sử dụng in nghiêng.
- Sử dụng **đậm** cho các lệnh, nút trên màn hình và tùy chọn menu.
- Sử dụng chữ nghiêng cho các biến mà người dùng phải tự cung cấp từ của mình.
- Sử dụng phông chữ khác cho văn bản hiển thị trên màn hình hoặc văn bản mà người dùng phải gõ vào.
- Đối với tên màn hình và trường, sử dụng phong cách viết hoa như được hiển thị trên màn hình nhưng không sử dụng bất kỳ cách làm nổi bật nào khác.
- Sử dụng chữ cái đầu tiên viết hoa cho các tên khóa nhưng không có bất kỳ đánh dấu nào khác.
- Để nhấn mạnh thêm, hãy sử dụng định dạng thông báo.
Lề, Thụt đầu dòng & Căn chỉnh
Như đã đề cập trong phần tiêu đề, một điểm nhấn hay là lùi lề văn bản từ một đến hai inch trong khi để các tiêu đề ở lề trái. Kiểu này thực hiện hai điều: nó làm cho các tiêu đề nổi bật, và nó rút ngắn độ dài dòng của văn bản thông thường.
Phông chữ & Màu sắc
Dưới đây là một số gợi ý liên quan đến phông chữ và màu sắc:
- Sử dụng chỉ một phông chữ thay thế, tối đa hai. Ví dụ, bạn có thể sử dụng Arial cho tiêu đề, Times New Roman cho văn bản chính, và Courier New cho văn bản hiển thị trên màn hình hoặc cho văn bản mà người dùng phải nhập vào.
- Nếu bạn sử dụng màu sắc, hãy sử dụng nó một cách tối giản. Ví dụ, nếu bạn có văn bản màu đen trên nền trắng, bạn có thể chọn một màu khác cho tiêu đề. Bạn có thể sử dụng màu đó cho tiêu đề của hình và bảng cũng như các nhãn cho thông báo (các nhãn thực tế "Lưu ý," "Cảnh báo," "Cẩn thận," và "Nguy hiểm" trên các thông báo).
- Tránh kết hợp màu sắc nền và văn bản không bình thường. Ví dụ, văn bản màu tím hoặc đỏ trên nền đen rất khó đọc. Hãy giữ văn bản màu đen trên nền trắng hoặc xám trừ khi có lý do chức năng mạnh mẽ cho một sự kết hợp màu sắc khác.
Tôi rất mong nhận được ý kiến, phản ứng và sự phê bình của bạn về chương này: phản hồi của bạn.
