Sổ tay

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

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

tất cả được 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 cẩm nang của bạn phải bao gồm theo một cách nào đó từng yếu tố này. Hơn nữa, những yếu tố này nên là một "phù hợp" tự nhiên, hợp lý cho dự án cẩm nang của bạn.

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

Đồ họa thông tin được tạo bởi NotebookLM cho 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 mọi thứ hoạt động, cách mọi thứ được kết hợp với nhau. Đối với những hướng dẫn phức tạp hơn, bạn cần phải biết một số khái niệm, lý thuyết, nền tảng và nguyên tắc để thực hiện các hướng dẫn. Hãy xem xét 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 bạn. Sử dụng các phần mềm 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 cách mà sắc độ, 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 sắc 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 những 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 cũng như các ký tự tham số. Bạn thực sự không thể hiểu cách sử dụng những lệnh này —theo hướng dẫn bằng cách 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ể thông minh làm theo các quy trình từng bước. Hướng dẫn là những danh sách số quen thuộc mà giúp bạn đi qua một quy trình một cách cẩn thận. Hướng dẫn có mặt ở khắp mọi nơi, trên bao bì sản phẩm, trong các hướng dẫn sử dụng đi kèm với thiết bị và máy tính.

Tham khảo. 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 bên trên, bạn cần phải nghiên cứu và học các khái niệm về tệp, thư mục, ký tự thay thế 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. Đây 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à vì vậy, sau một thời gian nữa, 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 trong lòng bàn tay. Nhưng thỉnh thoảng bạn quên một vài chi tiết nhỏ hoặc 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 đến phần tham khảo. Bạn có thể tháo rời phần khái niệm và hướng dẫn và vứt chúng đi. Tất cả những gì bạn cần là phần 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 cẩm nang. Từ liên kết dưới đây, bạn có thể tải phiên bản mẫu của cuốn cẩm nang. Nó bao gồm tất cả các trang yêu cầu ở định dạng tốt. Trong tài liệu Word này có 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à bổ sung một số kỹ năng chuyên nghiệp vào bộ kỹ năng của bạn.

Mẫu sách hướng dẫn

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 chữ Word để tạo ra một mục lục trông chuyên nghiệp. Thật khó để có được sự căn trái và căn phải cũng như các dấu chấm dẫn đúng cách:

Mẫu mục lục

Ví dụ trong Sách Hướng Dẫn

Dưới đây là một số liên kết đến các ví dụ sách hướng dẫn. Hãy lưu ý rằng có một số vấn đề trong các ví dụ, hầu hết tôi đã có bình luận. Một số trong số này là sách hướng dẫn biên giới. Điều làm cho một sách hướng dẫn đối với tôi 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ụ.

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

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ẽ đến sớm!

Tôi rất trân trọng những suy nghĩ, phản ứng, và chỉ trích của bạn về chương này: phản hồi của bạn—David McMurrey.