Sổ tay

Một sổ tay, như chúng tôi đang định nghĩa ở đây, là sự kết hợp của các yếu tố sau:

• khái niệm thông tin
• hướng dẫn thông tin
• thông tin tham khảo

tất cả đều tập trung vào một chủ đề cụ thể để đáp ứng nhu cầu của một đối tượng cụ thể. Nếu bạn đang tham gia một khóa học viết kỹ thuật sử dụng cuốn sách này, dự án sổ tay của bạn phải bao gồm theo cách nào đó cả ba yếu tố này. Hơn nữa, những yếu tố này nên là một "thích hợp" tự nhiên, hợp lý cho dự án cẩm nang của bạn.

Chắc chắn hãy kiểm tra ví dụ.

Infographic được tạo ra bởi NotebookLM của chương này

Cẩm nang cơ bản

Khái niệm. Thông tin khái niệm giải thích cách thức hoạt động của mọi thứ, cách mà mọi thứ được ghép lại với nhau. Đối với những hướng dẫn phức tạp hơn, bạn cần biết một số khái niệm, lý thuyết, nền tảng, nguyên tắc để thực hiện các hướng dẫn. Hãy xem ví dụ về chức năng phần mềm cho phép bạn chỉnh sửa hoặc tạo màu sắc của riêng mình. Sử dụng các công cụ như Photoshop, Illustration, CorelDraw hoặc Paint Shop Pro để làm điều này—các nút và thanh trượt thực tế—thì dễ dàng. Nhưng hiểu cách thức về sắc thái, cường độ, độ sáng, độ bão hòa, mật độ, độ tương phản, RGB—thì khó. Bạn phải biết lý thuyết màu máy tính để tạo ra màu sắc mà bạn cần.

Xem xét một ví dụ khác: các lệnh hệ thống tập tin Linux đơn giản —ls, cd, cp, mv, pwd. Để sử dụng các lệnh này, bạn cần hiểu tệp và thư mục là gì, và có lẽ cả hệ điều hành nữa, cũng như các ký tự đại diện. Bạn thực sự không thể hiểu cách sử dụng các lệnh này —theo hướng dẫn sử dụng chúng —trừ khi bạn hiểu những khái niệm cơ bản này.

Hướng dẫn. Nếu bạn hiểu các khái niệm cơ bản, thì bạn có thể một cách thông minh theo dõi các quy trình từng bước. Hướng dẫn là những danh sách số quen thuộc mà cẩn thận hướng dẫn bạn qua một quy trình. Hướng dẫn có mặt ở khắp nơi, trên bao bì sản phẩm, trong sách hướng dẫn sử dụng đi kèm với thiết bị và máy tính.

Tham chiếu. Danh mục thông tin cuối cùng liên quan đến thông tin tra cứu, hoặc thông tin tham khảo nhanh. Nếu bạn đã theo dõi ví dụ về hệ thống tệp ở trên, bạn đã phải nghiên cứu và học các khái niệm về tệp, thư mục, ký tự đại diện trước. Sau đó, bạn có thể theo dõi và hiểu các hướng dẫn về việc thay đổi thư mục, sao chép, xóa hoặc di chuyển tệp. Tuy nhiên, sau một thời gian, bạn không còn cần các hướng dẫn nữa, nhưng thỉnh thoảng bạn có những yêu cầu đặc biệt không được đề cập trong phần hướng dẫn hoặc bạn không thể nhớ một số quy trình đã được đề cập trong phần hướng dẫn. Bây giờ là lúc bạn cần thông tin tham khảo cơ bản: bạn chỉ cần đến phần đó và nhanh chóng tra cứu.

Và sau một thời gian dài, bạn không còn cần phần khái niệm hay phần hướng dẫn nữa: bạn đã quen thuộc với những quy trình đó, bạn biết chúng thuộc lòng. Nhưng thỉnh thoảng bạn quên một vài chi tiết nhỏ hoặc bạn có một nhiệm vụ đặc biệt mà bạn chưa bao giờ làm trước đây — đó là lúc bạn cần đến phần tài liệu tham khảo. Bạn có thể cắt rời phần khái niệm và phần hướng dẫn rồi ném chúng đi. Tất cả những gì bạn cần chỉ là phần tài liệu tham khảo.

Định dạng và Phong cách Sổ tay

Trong một khóa học viết kỹ thuật sử dụng cuốn sách này, bạn có thể được yêu cầu sử dụng các hướng dẫn cụ thể cho việc sử dụng tiêu đề, danh sách, thông báo, đồ họa, bảng, tài liệu và phần giới thiệu:

Mẫu hướng dẫn. Từ liên kết dưới đây, bạn có thể tải phiên bản mẫu của cuốn sổ tay. Nó bao gồm tất cả các trang cần thiết ở định dạng tốt. Được bao gồm trong tài liệu Word này là các kiểu đoạn và kiểu ký tự sẽ giúp công việc của bạn dễ dàng hơn và thêm một số kỹ năng chuyên nghiệp vào bộ kỹ năng của bạn.

Mẫu cẩm nang

Nội dung nguyên mẫu. Bản mẫu cho mục lục đặc biệt hữu ích: nó cung cấp cho bạn các kiểu Word để tạo ra một mục lục trông chuyên nghiệp. Thật khó để căn trái và căn phải cũng như sắp xếp các dấu chấm dẫn đúng cách:

Mẫu mục lục

Ví dụ về Sổ tay

Dưới đây là một số liên kết đến các ví dụ về sổ tay. Hãy lưu ý rằng có một số vấn đề trong các ví dụ này, phần lớn trong số đó tôi đã bình luận. Một số trong số này chỉ là sổ tay biên giới. Điều làm cho tôi coi đây là sổ tay là sự hiện diện của thảo luận khái niệm, hướng dẫn và thông tin tham khảo.

Hãy chắc chắn kiểm tra ví dụ.

Các Đề Xuất AI cho Sổ Tay

Danh sách kiểm tra, thường 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ố điều chỉnh. Sao chép đoạn văn sau, dán vào một hệ thống AI như Gemini của Google, và xem những gì bạn có thể đã bỏ lỡ.

Lưu ý: Tất cả các tài liệu tham khảo về nội dung, định dạng, phong cách của techdocs hoặc các thành phần của nó có thể được tìm thấy trong sách giáo khoa viết kỹ thuật trực tuyến.

sắp ra mắt!

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—David McMurrey.