Thiết kế trang có nghĩa khác nhau đối với mỗi 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 có nghĩa là thiết kế khiêm tốn, chức năng.
Để có thêm chi tiết hơn những gì bạn thấy ở đây, hãy tham khảo hai 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 phẩm gần đây nào. Prentice Hall.
- Công ty Microsoft. Tài liệu Hướng dẫn của Microsoft về Quy tắc Biên soạn cho Các Ấn phẩm Kỹ thuật. Phiên bản gần đây nhất. Microsoft Press.
Chân trang và Đầu trang
Người ta thường nhầm lẫn giữa tiêu đề và các đoạn tiêu đề. Các đoạn tiêu đề, được đề cập trong tiêu đề các cụm từ đó có xuất hiện không trong khu vực cơ thể của một tài liệu. Tiê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 trong khu vực đầu trang, điều này khiến nó xuất hiện ở đầu mỗi trang tiếp theo.
Hãy xem 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 xen kẽ, 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 đề sẽ được trình bày dưới đây. Để có thảo luận chi tiết hơn, xem chương về tiêu đề trong sách giáo khoa trực tuyến.
- Sử dụng tiêu đề một cách thoải mái, có lẽ một tiêu đề cho mỗi hai đến ba đoạn. Tất nhiên, việc sử dụng tiêu đề cũng có thể thái quá: nhiều tiêu đề với chỉ một hoặc hai câu cho mỗi tiêu đề sẽ không hiệu quả.
- Thiết kế tiêu đề sao cho chúng rõ ràng chỉ ra mức độ của chúng. Sử dụng kích thước chữ, kiểu chữ, màu sắc, in đậm, nghiêng, căn chỉnh theo cách mà mức độ của tiêu đề trở nên rõ ràng. ("Mức độ" của các tiêu đề giống như các 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ứ thế tiếp tục.)
- Làm cho tiêu đề mô tả rõ nội dung của các phần mà chúng giới thiệu. Những tiêu đề như "Kiến thức Kỹ thuật" không cung cấp thông tin gì cho ai.
- Làm tiêu đề song song Trong cách diễn đạt. Sự song song gửi đến độc giả những gợi ý quan trọng về việc liệu phần này có tương tự về bản chất với những phần trước đó hay không.
- Tránh "tiêu đề đơn độc"—đó là khái niệm giống như có một "A" mà không có "B" hoặc một "1" mà không có "2" trong các đề cương.
- 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 xen giữa.
- Tránh việc sử dụng đại từ khi đề cập đến các tiêu đề trong đoạn văn sau tiêu đề. Nếu bạn 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 nổi bật tiêu đề hơn và giảm độ dài của các dòng văn bản thông 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 toàn bộ 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ỉ ra các cấp độ tiêu đề. Một tiêu đề chạy vào "chạy vào" phần đầ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ự kết hợp nào đó của chữ in đậm, chữ 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 các điểm quan trọng, cho phép quét nhanh văn bản và cung cấp nhiều không gian trắng hơn. Dưới đây là một số hướng dẫn tiêu chuẩn về danh sách. Để có một cuộc thảo luận chi tiết hơn, xem chương về danh sách.
- Sử dụng danh sách có đánh số cho các mục cần theo thứ tự hoặc phải được tham chiếu bằng số. Sử dụng danh sách có dấu gạch đầu dòng cho các mục không cần theo thứ tự.
- Sử dụng định dạng danh sách số và danh sách gạch đầu dòng 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 áp dụng 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 câu mở đầu; không sử dụng tiêu đề như là câu mở đầu cho danh sách.
- Trừ khi phong cách của tổ chức bạn ghi overriding, hãy sử dụng dấu chấm cho các mục trong danh sách 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ữ cái hoa hoặc chữ thường ở đầu mục danh sách, nhưng làm điều đó một cách 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 cho mục 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 căn chỉnh với văn bản hoặc cấp độ trước đó.
- Tránh việc sử dụng danh sách quá mức hoặ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 khối văn bản được định dạng đặc biệt nhằm cảnh báo người đọc về những điểm đặc biệt, ngoại lệ, các vấn đề tiềm ẩn hoặc nguy hiểm. Dưới đây trình bày một số hướng dẫn tiêu chuẩn cho thông báo. Để có thảo luận chi tiết hơn, xem chương về thông báo.
- Sử dụng một hệ thống thông báo chuẩn, trong đó các thông báo trở nên nổi bật và dễ thấy hơn khi chúng trở nên nghiêm trọng hơn.
- Xem xét việc sử dụng hệ thống phân cấp này:
- thông báo nguy hiểm cho các tình huống có khả năng gây chấn thương 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 cho 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 những đ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 đó.
- Dù bạn sử dụng kiểu thiết kế thông báo nào, hãy tránh văn bản dài in đậm hoàn toàn, in nghiêng hoàn toàn, hoặc 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 điều gì sẽ xảy ra nếu họ bỏ qua cảnh báo, trong những điều kiện nào thì nên sử dụng câu nói này, và cách phục hồi nếu câu nói bị bỏ qua.
- Làm cho văn bản của thông báo ngắn gọn, nhưng không đánh đổi sự rõ ràng. Tránh phong cách viết ngắn gọn như bỏ sót các mạo từ. a, an, cái) trong thông báo.
- Trong danh sách đánh số, căn chỉnh thông báo về phía văn bản của mục trong danh sách mà chúng áp dụng.
- Trí tuệ chuẩn mực về việc đặt thông báo trước Bước mà vấn đề tiềm ẩn tồn tại có thể gây ra vấn đề trong việc định dạng. Nếu có thể, hãy nêu rõ các cảnh báo, lưu ý hoặc nguy hiểm ngay từ đầu của 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à những 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 cần thiết phải bao gồm chú thích hình ảnh (tiêu đề) cho mỗi hình, nhưng khi bạn làm vậy, hãy đặt nó dưới đây hình ảnh.
- Ví dụ, trong hướng dẫn khi các hình ảnh có 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
Các bảng giống như danh sách thẳng đứng, đã được thảo luận trước đó, nhưng có cấu trúc và hì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 thành bảng. Ví dụ, một loạt các thuật ngữ và định nghĩa là một cách sử dụng điển hình cho bảng. Dưới đây trình bày một số hướng dẫn tiêu chuẩn cho bảng. Để thảo luận chi tiết hơn, xem chương về bảng.
- Tìm kiế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 dưới dạng bảng.
- Trong văn bản trước bảng, 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 tạo thành hàng đầu tiên 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 cân nhắc việc sử dụng một số loại làm nổi bật cho các tiêu đề cột và hàng này.
- Căn lề 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 lề 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.
Làm nổi bật
Tài liệu phần mềm thường sử dụng nhiều kỹ thuật làm nổi bật. Ở đây, việc làm nổi bật đề cập đến việc in đậm, in nghiêng, font chữ khác nhau, chữ 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 là một số hướng dẫn tiêu chuẩn cho việc làm nổi bật. Để thảo luận chi tiết hơn, hãy xem chương về nổi bật.
- Thiết lập một kế hoạch cho việc sử dụng đánh dấu, và áp dụng nó một cách nhất quán. Sử dụng đánh dấu cho những lý do cụ thể, chức năng. Tránh đánh dấu quá nhiều; tránh các sơ đồ đánh dấu phức tạp.
- Hãy xem xét việc sử dụng sơ đồ đánh dấu khá tiêu chuẩn này:
- Để nhấn mạnh đơn giản, sử dụng chữ nghiêng.
- Sử dụng chữ **in đậ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ự điền từ của mình.
- Sử dụng một 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 kiểu chữ hoa như hiển thị trên màn hình nhưng không sử dụng bất kỳ cách nhấn mạnh nào khác.
- Sử dụng chữ hoa cho tên khóa nhưng không có định dạng nổi bật 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 về tiêu đề, một cách làm hay là thụt lề văn bản từ một đến hai inch trong khi để các tiêu đề ở lề trái. Phong cách này có hai tác dụng: nó làm cho các tiêu đề nổi bật và rút ngắn chiều dài dòng của văn bản thường.
Phông chữ & Màu sắc
Dưới đây là một số gợi ý về phông chữ và màu sắc:
- Chỉ sử dụng 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 văn bản mà người dùng phải gõ vào.
- Nếu bạn sử dụng màu sắc, hãy sử dụng một cách tối giản. Chẳng hạn, 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 thẻ cho thông báo (các nhãn "Lưu ý," "Cảnh báo," "Thận trọng," và "Nguy hiểm" trên thông báo).
- Tránh các sự kết hợp màu sắc nền và văn bản bất thường. Ví dụ, văn bản màu tím hoặc đỏ trên nền đen rất khó đọc. Nên sử dụng 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 trân trọ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.
