Trong chương này, thiết kế bìa sách nghĩa là nội dung, phong cách, định dạng, thiết kế và thứ tự của các thành phần điển hình khác nhau của một cuốn sách. "Thành phần" ở đây chỉ đến các phần thực tế hoặc trang của một cuốn sách như thông báo về ấn phẩm, lời giới thiệu, mục lục, hoặc bìa trước hoặc bìa sau. Trong chương thiết kế trang, thuật ngữ yếu tố đề cập đến những thứ có thể xảy ra nhiều lần ở hầu hết mọi nơi trong một cuốn sách, chẳng hạn như tiêu đề, chân trang, bảng, minh họa, danh sách, thông báo, đánh dấu và như vậy.

Bên dưới đây cung cấp một cái nhìn tổng quan về các thành phần điển hình của một cuốn sách kỹ thuật in và nội dung, định dạng, phong cách, cũng như trình tự của những thành phần đó. Chắc chắn rằng, không có tài liệu hướng dẫn sử dụng nào, sách hướng dẫn kỹ thuật, tài liệu tham khảo nhanh hay bất kỳ tài liệu nào khác có thể thực sự có tất cả các thành phần này được thiết kế và sắp xếp theo chính xác cách bạn sẽ đọc. Thay vào đó, đánh giá này sẽ đưa ra cái nhìn tổng quan về các khả năng—hãy nói là phạm vi các khả năng.

Ghi chú: Hiện tại, chúng tôi chỉ có ví dụ. hướng dẫn sử dụng được phát triển trong FrameMaker sau đó xuất ra PDF. Nó thiếu một bảng chú giải, nhưng tất cả các phần khác của một hướng dẫn người dùng điển hình đều có sẵn. (Tôi không thể hiểu chữ "d" trong "Filepad"!) Hãy lưu ý rằng nó không sử dụng một số yêu cầu về phông chữ và lề được liệt kê dưới đây.

Trước khi bạn bắt đầu đọc những gì bên dưới, hãy lấy một số cuốn sách về phần cứng và phần mềm để bạn có thể so sánh nội dung, phong cách, định dạng và thứ tự của chúng với những gì được thảo luận ở đây.

Để 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:

Bạn có thể thấy ví dụ về các thành phần sách này trong Thiết kế Techdoc.

Bìa trước và bìa sau

Tài liệu sản phẩm dành cho khách hàng trả tiền thường có bìa trước được thiết kế đẹp mắt, ngay cả khi bên trong, chất lượng của cuốn sách lại tầm thường. Trên bìa trước, bạn thường thấy một số hoặc tất cả các yếu tố sau:

Thật khó khăn để tìm ra định dạng tốt cho tên công ty, tên sản phẩm và tiêu đề sách. Đôi khi, những điều này có thể lên tới cả một đoạn văn! Các công ty thường chia rẽ về việc có nên chỉ định số phiên bản và số phát hành trên bìa trước hay không—một số công ty thì có; một số thì không. Tuy nhiên, hầu như bạn luôn thấy nền tảng được chỉ định—dù sản phẩm dành cho Macintosh, PC, UNIX, và các hệ thống khác.

Bìa sau của các hướng dẫn và sổ tay người dùng bản cứng thường rất đơn giản. Thông thường, nó chứa số đơn đặt hàng của sách, tên công ty với các biểu tượng thương hiệu thích hợp, biểu tượng bản quyền và cụm từ liên quan đến quyền sở hữu của cuốn sách, cùng một tuyên bố về quốc gia mà cuốn sách được in. Bạn cũng sẽ thấy mã vạch trên bìa sau. Xem xem phần mềm của bạn có thể tạo mã vạch không—bạn chỉ cần truy cập vào tiện ích mã vạch và nhập số đơn đặt hàng của sách, và tiện ích sẽ tạo mã vạch.

Trang tiêu đề

Trang tiêu đề thường là một bản sao của bìa trước, nhưng với một số yếu tố bị bỏ qua. Những yếu tố thường bị bỏ qua là hình ảnh, logo công ty hoặc sản phẩm, và các khẩu hiệu. Một số ấn phẩm kỹ thuật hoàn toàn bỏ qua trang tiêu đề vì sự trùng lặp dường như không cần thiết. (Và trong một đợt in 20.000 bản, một trang có ý nghĩa rất lớn!)

Tham khảo phiên bản

Thông báo phiên bản thường là lần đầu tiên xuất hiện văn bản thông thường trong một ấn phẩm kỹ thuật, mặc dù nó thường được in bằng kích thước nhỏ hơn. Nó xuất hiện ở mặt sau của trang tiêu đề. Nếu nhà xuất bản kỹ thuật áp dụng phương pháp tiết kiệm và xanh, và loại bỏ trang tiêu đề, thông báo phiên bản sẽ xuất hiện ở mặt sau của bìa trước.

Không ai thích đọc những dòng chữ nhỏ, nhưng hãy xem xét các tuyên bố thường được bao gồm trong thông báo phát hành:

Các điều khoản miễn trừ trách nhiệm

Xem phần về thông báo phát hành, nơi các thông báo miễn trừ thường được giấu kín. Nếu một sản phẩm hoặc bản công bố của nó cần một trang riêng biệt cho các thông báo miễn trừ, tôi sẽ không mua nó!

Thương hiệu

Mặc dù nhiều công ty có liệt kê nhãn hiệu của chính họ và của các công ty khác trong thông báo sửa đổi, một số người thích liệt kê chúng trên một trang riêng, ngay sau thông báo xuất bản. Những quyết định về vị trí này hầu như hoàn toàn thuộc về các luật sư của công ty; với tư cách là một nhà văn, bạn có thể sẽ phải tuân thủ cho dù quyết định đó có tệ đến đâu về thiết kế sách hay phong cách viết. Hãy nhớ, bạn chỉ liệt kê những tên sản phẩm đã được đăng ký thương hiệu xuất hiện trong cuốn sách cụ thể đó.

Bạn sẽ nhận thấy rằng một số ấn phẩm đã thực hiện các biện pháp cực đoan với các thương hiệu: họ sẽ đánh dấu sao hoặc chú thích cho lần xuất hiện đầu tiên, hoặc thậm chí mọi lần xuất hiện của tên sản phẩm đã đăng ký thương hiệu. Nhưng một lần nữa, đây là chỉ thị của các luật sư công ty mà các nhà viết kỹ thuật phải chấp nhận, dù có buồn lòng.

Bảo hành

Nhiều thông tin pháp lý hơn. Đây là các "bảo đảm" mà công ty sẽ hỗ trợ liên quan đến sản phẩm của mình. Đôi khi, chúng được công bố trong phần đầu của cuốn sách; nhưng, phù hợp hơn từ góc độ thiết kế sách, chúng được in trên một thẻ riêng và được chèn vào lớp bọc của cuốn sách hoặc sản phẩm. Một lần nữa, giống như các thông báo ấn bản, đây là văn bản bạn chỉ cần đưa vào như là "mẫu chuẩn" và đặt ở vị trí phù hợp trong cuốn sách.

Tuy nhiên, bạn nên biết rằng các công ty đôi khi duy trì nhiều phiên bản của thông báo phát hành, thông báo an toàn, bảo hành, thông cáo truyền thông và những thứ tương tự. Là một nhà văn, bạn phải đảm bảo rằng mình đang sử dụng phiên bản đúng (và, khi tìm ra phiên bản nào là chính xác, bạn sẽ có cơ hội ra ngoài và gặp gỡ nhiều người mới trong công ty!). Và bất cứ điều gì bạn làm, đừng thay đổi văn bản của những mục chuẩn này, dù chúng có được viết tệ đến mức nào. Những thay đổi thường phải được các luật sư của công ty phê duyệt (họ thường làm như vậy một cách miễn cưỡng và chỉ sau nhiều nỗ lực từ phía bạn và sau khi đã trôi qua nhiều thời gian).

Thông báo an toàn

Các sản phẩm phần cứng thường có một phần thông báo an toàn ở đầu sách của họ. Những thông báo này có thể xuất hiện như một tiểu mục của phần giới thiệu, chẳng hạn, hoặc như một phần riêng biệt. Những phần này thường tập hợp tất cả các cảnh báo nguy hiểm, cảnh báo và thận trọng xảy ra trong suốt cuốn sách và sắp xếp chúng theo một cách hợp lý nào đó. Nhưng ngay cả với thông báo này ở phía trước, sách phần cứng vẫn đặt các thông báo cá nhân tại các điểm mà chúng áp dụng. (Để biết thêm thông tin, xem) thông báo đặc biệt.)

Các tuyên bố giao tiếp

Sách phần cứng cũng yêu cầu các tuyên bố truyền thông như quy định bởi chính phủ các quốc gia mà các sản phẩm này được vận chuyển đến. Tại Hoa Kỳ, FCC yêu cầu một số tuyên bố truyền thông nhất định tùy thuộc vào "loại" của sản phẩm phần cứng. Là một nhà viết, bạn phải cẩn thận sử dụng tuyên bố truyền thông đúng cho sản phẩm mà bạn đang tài liệu hóa—và không được chỉnh sửa tuyên bố theo bất kỳ cách nào (các từ ngữ hợp pháp thiêng liêng!).

Mục lục

Mục lục (TOC) thường chứa ít nhất một mức độ chi tiết thứ hai (các tiêu đề 1 trong văn bản thực tế) để người đọc có thể tìm thấy những gì họ cần một cách chính xác hơn. Các nhà văn, biên tập viên và nhà thiết kế sách thường tranh luận về thứ tự của TOC. Về mặt khả năng sử dụng, tốt hơn nhiều khi có TOC càng gần phần đầu sách càng tốt, nếu không ở ngay phần đầu sách. Tuy nhiên, về mặt pháp lý, mọi người lo lắng rằng tất cả những tuyên bố giao tiếp, bảo hành, bản quyền, nhãn hiệu và thông báo an toàn nên được đặt lên hàng đầu. Ở những nơi mà khả năng sử dụng chiếm ưu thế, sách sử dụng mọi chiến thuật họ có để đưa vật liệu pháp lý này ra khỏi phần đầu: các bảo hành được đặt trên các thẻ riêng và được bọc co với sách hoặc sản phẩm; các bảo hành, tuyên bố giao tiếp, nhãn hiệu và những thứ khác có thể được đưa vào các phụ lục.

Gặp khó khăn trong việc tạo một bảng mục lục định dạng đẹp? Xem Tạo một Mục lục trông chuyên nghiệp

Danh sách các hình ảnh

Các tài liệu kỹ thuật dành cho người dùng thông thường thường không có danh sách hình ảnh. Thực tế, các hình ảnh đó thường không có tiêu đề hình ảnh đầy đủ. Nhưng điều này không có nghĩa là danh sách hình ảnh không có chỗ đứng trong các tài liệu kỹ thuật. Tất cả phụ thuộc vào người đọc và nhu cầu của họ—cũng như nội dung của cuốn sách. Nếu cuốn sách có bảng, minh họa, đồ thị, biểu đồ và những thứ khác mà người đọc muốn tìm trực tiếp, thì danh sách hình ảnh là cần thiết.

Lời tựa

Chức năng của phần giới thiệu là chuẩn bị cho người đọc sẵn sàng đọc cuốn sách. Nó thực hiện điều đó bằng cách:

Trong việc xuất bản sách truyền thống, lời nói đầu đến trước mục lục; nhưng như đã thảo luận trước đây trong mục lục Phần này, những người làm xuất bản kỹ thuật muốn bảng mục lục xuất hiện sớm hơn trong cuốn sách vì lý do khả năng sử dụng.

Các chương nội dung

Ồ vâng, và có thực sự có văn bản trong những cuốn sách này—không phải chỉ có phần đầu sách! Chỉ còn một điều khác để nói ở đây là hầu hết các cuốn sách kỹ thuật đều có các chương hoặc phần, và trong một số trường hợp, có cả các phần lớn. Xem chương về thiết kế trang về định dạng, kiểu dáng và thiết kế cho các phần tử như tiêu đề, chân trang, tiêu đề chính, danh sách, thông báo, bảng, đồ họa, tham chiếu chéo và đánh dấu.

Phụ lục

Như bạn biết, phụ lục là cho những tài liệu không có vẻ phù hợp với phần chính của cuốn sách nhưng cũng không thể bỏ qua trong cuốn sách. Phụ lục thường là nơi để những bảng biểu lớn và khó xử lý. Một số ấn phẩm kỹ thuật có những thứ như bảo hành trong phụ lục. Về định dạng, một phụ lục tương tự như một chương—ngoại trừ việc nó được đặt tên là "Phụ lục A" hoặc như vậy, và các tiêu đề và chân trang phù hợp với hệ thống đánh số và đặt tên khác (A-1, A-2, và tiếp theo cho các trang trong Phụ lục A).

Thuật ngữ

Một số ấn phẩm kỹ thuật bao gồm một phần các thuật ngữ chuyên ngành và định nghĩa của chúng. Lưu ý rằng hầu hết các từ điển sử dụng bố cục hai cột. Thông thường, mỗi thuật ngữ và định nghĩa của nó tạo thành một đoạn riêng biệt, với thuật ngữ được viết thường (trừ khi đó là tên riêng) và in đậm, theo sau là một dấu chấm, sau đó là định nghĩa bằng chữ rome thông thường. Cũng lưu ý rằng các định nghĩa thường không phải là câu hoàn chỉnh. Các định nghĩa từ điển tốt nên sử dụng kỹ thuật định nghĩa theo câu chính thức như đã mô tả trong chương định nghĩa các định nghĩa trực tuyến này. Nhiều định nghĩa thường được xác định bằng các số Ả Rập trong ngoặc. Các đoạn từ vựng cũng chứa Nhìn thấy tham chiếu đến các thuật ngữ ưu tiên và Xem thêm tham chiếu đến các thuật ngữ liên quan.

Mục lục

Chỉ mục thường là hai cột và cũng chứa Thấy tham chiếu đến các thuật ngữ được ưa chuộng và Xem thêm tham khảo các thuật ngữ liên quan. Xem chương về lập chỉ mục cho các quy trình và hướng dẫn để tạo ra các chỉ mục tốt.

Mẫu phản hồi độc giả

Trước khi Internet và mạng xã hội phát triển, một số ấn phẩm kỹ thuật có chứa một mẫu giấy để cho phép độc giả gửi ý kiến, câu hỏi và đánh giá về cuốn sách. Chắc chắn rằng, những mẫu này thường thu hút các khiếu nại về chức năng bị lỗi trong sản phẩm mà cuốn sách tài liệu. Với sự phát triển của Internet, những mẫu này đã chuyển sang trực tuyến, và các cuốn sách chỉ đơn giản chỉ ra vị trí của chúng trên mạng.

Thiết kế và bố cục sách

Thông thường, hướng dẫn sử dụng và tài liệu do các nhà sản xuất phần cứng và phần mềm tạo ra được thiết kế theo cách khá đơn giản và khô khan. Các công ty công nghệ cao phát triển các phiên bản và bản phát hành mới của sản phẩm của họ thậm chí có thể chỉ sau chín tháng. Trong bối cảnh này, thiết kế tinh vi là không thực tế. Dưới đây là một số đặc điểm bố cục và thiết kế điển hình mà bạn sẽ thấy:

Lưu ý: Điều này kết thúc cuộc thảo luận về sách in. các thành phần. Để hoàn thành cái nhìn tổng quan về thiết kế sách in, xem chương về thiết kế trang, mà bao gồm các yếu tố chẳng hạn như đầu trang và cuối trang, tiêu đề, danh sách, thông báo đặc biệt, bảng, đồ họa, làm nổi bật, tham chiếu chéo, và nhiều hơn nữa.

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.