Vui lòng nhấn vào đây để được trợ giúp David McMurrey trả tiền cho dịch vụ lưu trữ web:
Hãy ủng hộ bất kỳ số tiền nhỏ nào bạn có thể.
Viết kỹ thuật trực tuyến sẽ vẫn miễn phí.
Trang này đang được sửa chữa.
Một hướng dẫn sử dụng là một tài liệu kỹ thuật giải thích cách thực hiện các nhiệm vụ phổ biến của người dùng sản phẩm. Thông thường các nhiệm vụ là những hành động mà người dùng cần phải có khả năng thực hiện. The người dùng là ở mức độ kiến thức và kinh nghiệm mà sản phẩm mong muốn. Một số sản phẩm có người dùng cơ bản và người dùng nâng cao—một hướng dẫn sử dụng có thể đáp ứng một trong những nhu cầu đó hoặc cả hai. Hãy nghĩ đến một lò vi sóng: nó có thể có người dùng cơ bản, và chỉ có vậy. Mặt khác, một sản phẩm thiết kế đồ họa có thể có cả người dùng cơ bản và người dùng nâng cao.
Đồ họa thông tin được tạo ra bởi NotebookLLM của chương này
Trong chương này, thiết kế sách có nghĩa là nội dung, phong cách, định dạng, thiết kế và trình 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 đề cập đến các phần hoặc trang thực tế của một cuốn sách như thông báo phát hành, lời giới thiệu, mục lục, hoặc bìa trước hoặc bìa sau. Trong thiết-kế-trang chương, thuật ngữ yếu tố đề cập đến những thứ có thể xuất hiện 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à nhiều thứ khác.
Dưới đây là 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ư thứ tự của những thành phần đó. Chắc chắn rằng không có một hướng dẫn sử dụng, sách tham khảo kỹ thuật, tài liệu tham khảo nhanh hoặc tài liệu nào khác 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 cách mà bạn sắp đọc. Thay vào đó, bài đánh giá này sẽ cung cấp tổng quan về các khả năng—có thể nói là phạm vi các khả năng.
Lưu ý: 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 rồi 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ó mặt. (Tôi không thể hiểu chữ "d" trong "Filepad"!) Xin 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ê bên dưới.
Trước khi bạn bắt đầu đọc những điều sau đây, 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à cách sắp xếp 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 liệu tiêu chuẩn của ngành này:
- Tài liệu Kỹ thuật Sun. Đọc Tôi Trước! Bất kỳ ấn bản gần đây nào. Prentice Hall.
- Tập đoàn Microsoft. Hướng dẫn về 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.
Bạn có thể xem 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, nội dung có chất lượng thấp. Trên bìa trước, bạn thường sẽ thấy một số hoặc toàn bộ những điều sau đây:
- Tên công ty
- Tên sản phẩm
- Nền tảng sản phẩm hoặc hệ điều hành
- Số phiên bản sản phẩm và số phát hành
- Tiêu đề sách
- Biểu tượng công ty hoặc sản phẩm
- Biểu tượng thương hiệu
- Tác phẩm nghệ thuật
- Số đơn hàng sách
- Khẩu hiệu công ty hoặc sản phẩm
Thật khó khăn để tìm ra cách định dạng tốt cho tên công ty, tên sản phẩm và tiêu đề sách. Đôi khi, chúng có thể lên tới một đoạn văn dài! Các công ty thường có ý kiến trái chiều về việc có nên chỉ rõ 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 có; một số thì không. Tuy nhiên, gần như luôn luôn, bạn sẽ thấy nền tảng được chỉ rõ—cho dù sản phẩm đó là dành cho Macintosh, PC, UNIX, và các loại khác.
Ví dụ về trang bìa.
Bìa sau của sách hướng dẫn và sổ tay 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 kèm theo các biểu tượng nhãn hiệu phù hợp, một ký hiệu bản quyền và cụm từ về quyền sở hữu của cuốn sách, và một thông báo về quốc gia nơi cuốn sách được in. Bạn cũng sẽ tìm thấy mã vạch ở bìa sau. Hãy xem liệu phần mềm của bạn có thể tạo ra mã vạch—bạn chỉ cần truy cập vào tiện ích mã vạch và gõ số đơn đặt hàng của sách, tiện ích sẽ tạo ra mã vạch.
Trang tiêu đề
Trang bìa thường giống hệt bìa trước, nhưng có một số yếu tố bị bỏ qua. Thông thường bị bỏ qua là các hình ảnh, logo công ty hoặc sản phẩm, và khẩu hiệu. Một số ấn phẩm kỹ thuật hoàn toàn bỏ qua trang bìa vì sự trùng lặp dường như không cần thiết. (Và trong một lượt in 20.000 bản, một trang có ý nghĩa rất lớn!)
Ví dụ về trang bìa.
Thông báo phát hành
Thông báo phiên bản thường là trường hợp đầu tiên của văn bản thông thường trong một ấn phẩm kỹ thuật, mặc dù nó thường ở kích thước chữ 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 chữ in nhỏ, nhưng hãy xem những tuyên bố thường được bao gồm trong thông báo phát hành:
Ví dụ về thông báo bổ sung
Thương hiệu
Việc bạn liệt kê các nhãn hiệu và cách bạn lắng nghe là thẩm quyền của các luật sư công ty. Trong mọi trường hợp, bạn chỉ liệt kê những tên sản phẩm đã được đăng ký nhãn hiệu xuất hiện trong hướng dẫn sử dụng cụ thể đó.
Thường thì, nhãn hiệu được chỉ ra:
- trong thông báo biên tập (như minh họa ở trên cho thấy)
- ở một phần riêng biệt nào đó trong hướng dẫn sử dụng
nhắc đến ghi chú đó
Nếu các luật sư doanh nghiệp muốn mỗi lần xuất hiện của tên sản phẩm đã được đăng ký thương hiệu được đánh dấu bằng một dấu hoa thị hoặc chú thích, hãy cố gắng thuyết phục họ không sử dụng kiểu thiết kế trang tồi tệ đó. Việc rải rác văn bản với các dấu hoa thị hoặc số chú thích sẽ gây phân tâm cho người đọc.
Bảo hành
Các bảo hành đi kèm với sản phẩm phần cứng vật lý—không phải phần mềm. Các luật sư doanh nghiệp chịu trách nhiệm về ngôn ngữ và định dạng bảo hành. Nếu bạn đang tạo một hướng dẫn sử dụng hoặc sách ví dụ cho danh mục đầu tư của mình, bạn có thể sử dụng "ví dụ bảo hành" ẩn danh này.cửa sổ bật lên để cho thấy bạn nhận thức rằng các bảo hành phải được bao gồm.
bảo hành phần mềm?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 ở phía trước của sách. Những phần này có thể xuất hiện như một tiểu mục trong lời nói đầ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 thông báo nguy hiểm, cảnh báo và thận trọng xuất hiện xuyên 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 cảnh báo ở phía trước này, sách phần cứng vẫn đặt các thông báo riêng lẻ tại những đ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 cần có các tuyên bố về truyền thông như được quy định bởi các chính phủ của các quốc gia mà các sản phẩm này được vận chuyển tới. Tại Hoa Kỳ, FCC yêu cầu một số tuyên bố về truyền thông tùy thuộc vào "lớp" của sản phẩm phần cứng. Là một nhà văn, 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 cách nào (những từ ngữ pháp lý 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ế) để độc giả 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 tiện ích, tốt hơn nhiều khi có TOC gần với phần đầu của sách nhất có thể, nếu không muốn nói là ở ngay đầ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ố liên lạc, bảo hành, bản quyền, nhãn hiệu và thông báo an toàn nên được đặt ở trước. Ở những nơi mà tiện ích thắng thế, sách sử dụng mọi chiến thuật họ có để đưa các tài liệu pháp lý này ra khỏi phần đầu: bảo hành được đặt trên các thẻ riêng và được bọc co lại với sách hoặc sản phẩm; bảo hành, tuyên bố liên lạc, nhãn hiệu và những thứ tương tự có thể được đưa vào phần phụ lục.
Gặp khó khăn khi tạo mục lục được định dạng đẹp? Xem Tạo một mục lục trông chuyên nghiệp
Danh sách hình ảnh
Các tài liệu kỹ thuật dành cho người dùng bình thường thường không có danh sách hình. Thực tế, các hình ảnh thường không có tiêu đề hình đầy đủ. Nhưng điều này không có nghĩa là danh sách hình không có chỗ đứng trong các tài liệu kỹ thuật. Tất cả phụ thuộc vào độc giả và nhu cầu của độc giả — và nội dung của cuốn sách. Nếu cuốn sách chứa các bảng, hình minh họa, biểu đồ, đồ thị và các nội dung khác mà độc giả muốn tìm kiếm trực tiếp, danh sách hình là cần thiết.
Lời nói đầu
Chức năng của lời giới thiệu là chuẩn bị cho độc giả sẵn sàng để đọc cuốn sách. Nó thực hiện điều đó bằng cách:
- đặc trưng nội dung và mục đích của cuốn sách
- xác định hoặc thậm chí mô tả ngắn gọn sản phẩm mà cuốn sách hỗ trợ
- giải thích loại độc giả mà cuốn sách này hướng tới
- phác thảo nội dung chính của cuốn sách
- cho thấy bất kỳ quy ước hoặc thuật ngữ đặc biệt nào được sử dụng trong cuốn sách
- cung cấp hỗ trợ và số liệu tiếp thị, và những thứ tương tự khác
Trong xuất bản sách truyền thống, lời giới thiệu xuất hiện trước mục lục; nhưng như đã thảo luận trước đó trong mục lục Trong phần này, những người làm xuất bản kỹ thuật muốn Mục lục xuất hiện sớm hơn trong cuốn sách vì lý do tính khả dụng.
Các chương thân bài
Ôi vâng, và thực tế là có văn bản trong những cuốn sách này—không phải chỉ có phần trước! Ít điều khác để nói ở đây ngoài việc hầu hết các cuốn sách kỹ thuật có các chương hoặc phần, và trong một số trường hợp, có các phần lớn. Xem chương về thiết kế trang để định dạng, phong cách và thiết kế cho các yếu tố như tiêu đề, chân trang, tiêu đề, danh sách, thông báo, bảng, đồ họa, tham chiếu chéo và làm nổi bật.
Phụ lục
Như bạn đã biết, phụ lục là dành cho những tài liệu dường như không vừa với phần chính của một 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 cho những bảng biểu lớn và khó xử lý. Một số xuất bản phẩm kỹ thuật có những thứ như bảo hành trong phụ lục. Về mặt định dạng, một phụ lục giống như một chương—ngoại trừ việc nó được đặt tên là "Phụ lục A" hoặc một cái tên tương tự, và các tiêu đề và chân trang phù hợp với quy ước đánh số và đặt tên khác (A-1, A-2, v.v. cho các trang trong Phụ lục A).
Từ điển 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 chú thích sử dụng một 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ữ 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ữ kiểu thường. Cũng hãy lưu ý rằng định nghĩa thường không phải là những câu hoàn chỉnh. Các định nghĩa trong từ điển tốt nên sử dụng kỹ thuật định nghĩa bằng 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 dấu ngoặc đơn. Các đoạn từ điển cũng chứa Xem 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.
Chỉ mục
Chỉ mục thường cũng có hai cột và cũng chứa Xem các 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. 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.
Biểu 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ó dạng bản sao cứng để cho phép người đọc gửi ý kiến, câu hỏi và đánh giá về cuốn sách. Tất nhiên, những mẫu đơn này thường nhận được khiếu nại về chức năng bị lỗi trong sản phẩm mà cuốn sách ghi chép. Với sự phát triển của internet, các mẫu đơn này đã chuyển lên 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ế khá đơn giản và khắc khổ. 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 đôi khi chỉ sau chín tháng. Trong bối cảnh này, thiết kế tinh vi thực sự không thực tế. Dưới đây là một số tính năng về cách bố trí và thiết kế điển hình mà bạn sẽ thấy:
- Kích thước trang thường được xác định bởi các yếu tố đóng gói cũng như bởi các kích thước trang tiêu chuẩn có sẵn từ các công ty in. Khi kích thước trang không phải là một rào cản, một số công ty sẽ sử dụng kích thước trang 8.5 × 11 inch— điều này giúp việc sản xuất dễ dàng hơn cho các nhà văn.
- Các trang thường được thiết kế với các trang bên phải và bên trái xen kẽ. Chân trang của trang bên trái (chẵn) bắt đầu bằng số trang và kết thúc bằng tiêu đề của cuốn sách. Chân trang của trang bên phải (lẻ) bắt đầu bằng tiêu đề của chương và kết thúc bằng số trang.
- Thực tiễn có sự khác biệt về việc đánh số trang là liên tục trong toàn bộ cuốn sách hay theo từng chương.
- Trừ khi các trang khá nhỏ, thiết kế đầu mục lơ lửng liên quan đến các trang là khá phổ biến trong các tài liệu kỹ thuật. Thụt đầu dòng thường là một inch đến một inch rưỡi.
- Phông chữ thường là Times New Roman cỡ 12 cho phần thân văn bản và Arial cho tiêu đề. Khoảng cách dòng và khoảng cách từ được sử dụng theo tiêu chuẩn. Xem chương về tô đậm cho các vấn đề kiểu chữ khác.
- Độ lề khá tiêu chuẩn, từ một đến hai inch ở xung quanh. Thông thường, một nửa inch extra được sử dụng cho các lề bên trong để dành cho việc đóng bìa.
- Thông thường, màu sắc là không được sử dụng trong các hướng dẫn và sách hướng dẫn này, thường là vì lý do chi phí và hiệu quả.
Mục lục
MỤC LỤC
Dù bạn sử dụng định dạng mục lục (TOC) nào, đây là những tiêu chuẩn chung:
- Chỉ số trang bắt đầu. Mặc dù một số công cụ tạo mục lục tự động hiển thị khoảng trang, tiêu chuẩn chỉ là số trang đầu tiên.
- Cấp độ tiêu đề cần bao gồm. Như đã trình bày trong bảng mục lục ở trên, hiển thị hai cấp tiêu đề hàng đầu trừ khi hướng dẫn người dùng có nhiều tiêu đề phụ. Bảng mục lục nên cung cấp một cách nhìn tổng quan để tìm thông tin nhanh chóng.
- Khoảng cách và chữ hoa. Lưu ý cách các mục văn bản trong mục lục ở trên được thụt lề. Các tiêu đề cấp một sử dụng chữ in hoa; các tiêu đề cấp hai sử dụng chữ cái đầu của mỗi từ chính in hoa; các tiêu đề cấp ba sử dụng kiểu chữ thường.
- Khoảng cách dọc. Lưu ý rằng các phần cấp một có khoảng trống thêm ở trên và dưới, điều này tăng cường khả năng đọc.
Tùy thuộc vào yêu cầu của tổ chức bạn, bạn có hai lựa chọn định dạng cho mục lục (TOC):
Mục lục này sử dụng kiểu đánh số thập phân cho các chương và số phần, điều này rất phổ biến trong các hướng dẫn sử dụng. Các phần khác trong cuốn sách này sử dụng kiểu số La Mã chữ hoa chỉ cho các chương cấp cao nhất.
Gặp khó khăn trong việc tạo một mục lục được định dạng đẹp? Xem Tạo một bảng mục lục nhìn chuyên nghiệp
Dấu phẩy và số trang. Nếu định dạng leader-dot không cần thiết và bạn muốn tránh nó, bạn có thể sử dụng định dạng phổ biến này:
Xem ví dụ này về lời nói đầu:
Đoạn TOC đơn giản với dấu phẩy và số trang.Danh sách hình ảnh
Không thường được bao gồm trong hướng dẫn sử dụng...
-->Lời nói đầu
Hướng Dẫn Sử Dụng Các Chương Chính
Phụ lục
Chỉ mục
Các yếu tố hướng dẫn người dùng khác
Tiêu đề
Danh sách gạch đầu dòng và danh sách đánh số
Ký hiệu, Số, và Viết tắt
Tiêu đề Đồ họa và Hình ảnh
Tham chiếu chéo
Đánh số trang
Các gợi ý AI cho hướng dẫn sử dụng
Danh sách kiểm tra, thường thì không được đọc, có thể được sử dụng làm nguồn cho các gợi ý AI với một số sửa đổi. Sao chép đoạn văn dưới đây, dán vào một hệ thống AI như Gemini của Google, và xem bạn có thể đã bỏ lỡ điều gì.
Lưu ý: Tất cả các tham chiếu đến nội dung, định dạng, phong cách của hướng dẫn người dùng hoặc các thành phần của chúng có thể được tìm thấy trong sách giáo trình viết kỹ thuật trực tuyến.
Khi bạn muốn sử dụng AI để đánh giá một dự án viết, hãy giới thiệu bản thân, cho AI biết bạn là ai, bạn muốn gì. Hãy cung cấp cho AI một điểm tham chiếu để thực hiện các đánh giá như một giáo trình trực tuyến. Sau đó, đăng những gì bạn muốn AI kiểm tra trong đánh giá của nó.
Chỉnh sửa phần giới thiệu cho phù hợp với danh tính của bạn.
|
Hướng Dẫn Người Dùng Gợi Ý AI Xin chào, AI. Tôi yêu cầu bạn đánh giá hướng dẫn được viết bởi một sinh viên năm hai đại học ở Mỹ. Dưới đây là tóm tắt các chương sách về hướng dẫn và thông báo để sử dụng làm cơ sở cho việc đánh giá của bạn. (Thông tin nhận dạng đã được che đậy):
|
Thông tin liên quan
Cách Viết Các Chủ Đề Trợ Giúp Thân Thiện Với Người Mới Bắt Đầu. clickhelp.com
Cách viết tài liệu hướng dẫn người dùng. techscribe
Hướng dẫn sử dụng. techscribe
Tôi rất trân trọng ý kiến, phản ứng và sự chỉ trích của bạn về chương này: phản hồi của bạn—David McMurrey.
