Vui lòng nhấn vào đây để giúp đỡ. David McMurrey trả tiền cho dịch vụ lưu trữ web:
Hãy quyên góp 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í.
Dưới đây là hai định nghĩa về tài liệu hướng dẫn:
- Một hướng dẫn là một tài liệu, ấn phẩm, hoặc tài nguyên số cung cấp hướng dẫn từng bước, mẹo, và thông tin về cách thực hiện các nhiệm vụ cụ thể, sử dụng sản phẩm, hoặc hiểu các khái niệm phức tạp. Một hướng dẫn cũng có thể bao gồm thông tin khắc phục sự cố, liên kết đến các cộng đồng liên quan, và liên kết đến các nghiên cứu liên quan.
- Ở nơi khác, trong thế giới chính phủ, tài liệu hướng dẫn, hoặc hướng dẫn Tài liệu, nhằm mục đích cung cấp thông tin hữu ích cho công chúng, chẳng hạn như làm rõ nghĩa vụ theo một luật hoặc quy định hiện có, hoặc cung cấp thông tin về quy trình của cơ quan. Nói cách khác, chúng chuyển ngữ ngôn ngữ pháp lý phức tạp của các quy tắc hành chính để giúp công chúng tuân thủ những quy tắc đó.
Tài liệu hướng dẫn
Một tài liệu hướng dẫn, về bản chất, là một tập hợp các chỉ dẫn nhưng có thêm các tài nguyên khác để làm cho nó hữu ích hơn.
Đánh giá chương về hướng dẫn, bạn thấy rằng hướng dẫn được phân biệt bởi một phần mô tả thiết bị và vật tư cần thiết và bởi một phần mô tả các bước quy trình thường ở định dạng danh sách số dọc. Bao gồm một phần như vậy trong tài liệu hướng dẫn của bạn—nhưng đó không phải là tất cả!
Hướng Dẫn Nền Tảng: Hướng Dẫn
Sáu mục đầu tiên trong danh sách tiêu đề dưới đây trông giống như bất kỳ bộ hướng dẫn nào—nhưng không phải phần còn lại!
Chọn Địa Điểm Phù Hợp
Chọn Kích Thước Vườn
Chọn rau củ
Xác định Nơi và Thời Điểm Gieo Trồng
Xác định Khi Nào Trồng Gì
Thiết kế Kế Hoạch Vườn
Mua dụng cụ làm vườn
Khu vực Trồng Rau Vùng Mỹ
Nhiệt độ mùa trung bình của Hoa Kỳ
Côn trùng gây hại phổ biến trong vườn rau và biện pháp kiểm soát
Tài nguyên làm vườn rau trực tuyến
Diễn đàn và Cộng đồng Trồng Rau
Đã được điều chỉnh với sự cho phép từ Vườn Rau Cải Cho Người Mới Bắt Đầu: Hướng Dẫn Đầy Đủ
Ngay cả độ dài và chi tiết của sáu mục đầu tiên cũng lớn hơn những gì bạn mong đợi trong một bộ hướng dẫn hai trang thông thường, chưa kể đến những hình ảnh trang trí đẹp mắt.
Dưới đây là danh sách tiêu đề khác báo hiệu một tài liệu dài hơn nhiều so với một hoặc hai trang hướng dẫn:
Lựa Chọn Địa Điểm Vườn
Lựa Chọn Cây Trồng
Kế hoạch Vườn: Vị trí, Luân canh
Chuẩn Bị Đất
Thụ tinh
Trồng cây
Tưới nước
Kiểm Soát Cỏ Dại
Lớp phủ đất
Kiểm soát sâu bệnh
Thu hoạch
Những điều nên và không nên trong làm vườn
Được điều chỉnh với sự cho phép từ Hướng Dẫn Trồng Rau Tại Nhà Ở Texas Joseph Masabn, Texas A&M AgriLife.
Hướng dẫn bổ sung: Các phần bổ sung
Những gì làm cho một bộ hướng dẫn trở thành một hướng dẫn là các phụ lục được thảo luận trong phần đó.
Lý thuyết, Thông tin khái niệm
Phần mềm tạo hình ảnh và chỉnh sửa có trách nhiệm nghiêm túc trong việc giải thích các đường cong màu, mặt nạ lớp, kênh. Phần mềm hình ảnh miễn phí tuyệt vời GIMP có một số giải thích tốt về các khái niệm tại Đường cong màu cơ bản:
|
Màu Pixel — bởi Pat David Nhớ rằng, mỗi pixel được đại diện bởi một tổ hợp của 3 màu: Đỏ, Xanh lá, và Xanh dương. Trong GIMP (hiện đang ở 8-bit), điều đó có nghĩa là mỗi màu RGB có thể có giá trị từ 0–255, và việc kết hợp ba màu này với các mức độ khác nhau trong mỗi kênh sẽ tạo ra tất cả các màu mà bạn có thể thấy trong hình ảnh của mình. Nếu tất cả ba kênh đều có giá trị là 255, thì màu sắc sinh ra sẽ là trắng tinh khiết. Nếu tất cả ba kênh đều có giá trị là 0 – thì màu sắc sinh ra sẽ là đen tinh khiết. Nếu cả ba kênh đều có cùng một giá trị, thì bạn sẽ nhận được một tông màu xám (128,128,128 sẽ là một màu xám trung tính, ví dụ). Dưới đây là một số cài đặt màu trong GIMP: 
Như bạn có thể thấy, có nhiều màu xanh hơn bất kỳ màu nào khác (cuối cùng thì đây cũng là một pixel có tông màu xanh), tiếp theo là màu xanh lá cây, rồi một chút màu đỏ. Nếu chúng ta thay đổi giá trị của từng kênh, nhưng giữ tỷ lệ giữa Đỏ, Xanh lá cây và Xanh dương giống nhau, thì chúng ta sẽ giữ màu sắc giống nhau và chỉ làm sáng hoặc tối pixel một chút. |
Thông tin khắc phục sự cố
Thông tin khắc phục sự cố thường được định dạng theo khung thử cái này, thử cái kia.
|
Vấn đề: Nút nguồn không khởi động được máy tính ▢ Giải pháp 1: Nếu máy tính của bạn không khởi động, hãy bắt đầu kiểm tra dây nguồn để xác nhận rằng nó được cắm chắc chắn vào phía sau thùng máy tính và ổ cắm điện. ▢ Giải pháp 1: Nếu máy tính của bạn không khởi động, hãy bắt đầu bằng cách kiểm tra dây nguồn để xác nhận rằng nó đã được cắm chặt vào phía sau vỏ máy tính và ổ cắm điện. ▢ Giải pháp 2: Nếu nó được cắm vào một ổ cắm, hãy chắc chắn rằng đó là một ổ cắm hoạt động. Để kiểm tra ổ cắm của bạn, bạn có thể cắm một thiết bị điện khác, chẳng hạn như một cái đèn. ▢ Giải pháp 3: Nếu máy tính được cắm vào bộ nguồn chống sét, hãy xác minh rằng nó đang bật. Bạn có thể phải reset bộ nguồn chống sét bằng cách tắt nó đi rồi bật lại. Bạn cũng có thể cắm một chiếc đèn hoặc thiết bị khác vào bộ nguồn chống sét để xác nhận rằng nó đang hoạt động đúng cách. ▢ Giải pháp 4: Nếu bạn đang sử dụng laptop, pin có thể chưa được sạc. Cắm bộ chuyển đổi AC vào ổ điện, sau đó thử bật laptop. Nếu nó vẫn không khởi động, bạn có thể cần chờ vài phút và thử lại. |
Nguồn: Được sửa đổi với sự cho phép từ Kiến thức Cơ bản về Máy tính - Kỹ thuật Khắc phục Vấn đề Cơ bản
Cộng đồng và Diễn đàn
Tài nguyên liên quan
Những Gợi ý AI cho Tài liệu Hướng dẫn
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 lời nhắc AI với một số điều chỉnh. Sao chép đoạn sau, dán vào một hệ thống AI như Google's Gemini, 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 techdocs hoặc các thành phần của nó có thể được tìm thấy trong sách giáo trình viết kỹ thuật trực tuyến.
sắp ra mắt!
Tài liệu hướng dẫn
Như đã trình bày ở đây, các tài liệu hướng dẫn chuyển đổi các quy tắc hành chính thành thông tin có thể đọc được bởi những người không chuyên về pháp lý.
- Một quy định hành chính được đánh dấu bởi ngôn ngữ pháp lý nặng nề và thường là ngôn ngữ kỹ thuật. Dưới đây là một đoạn trích ví dụ: PHỤ CHƯƠNG B: ĐỐT NGOÀI TRỜI §§111.201, 111.203, 111.205, 111.207, 111.209, 111.211, 111.213, 111.215, 111.217, 111.219, 111.221. Ủy ban Chất lượng Môi trường Texas, Có hiệu lực từ năm 2017.
- Một tài liệu hướng dẫn, mặt khác, cố gắng giải thích bằng ngôn ngữ dễ hiểu các điểm chính trong quy tắc hành chính để giúp công dân bình thường tuân thủ quy tắc. Dưới đây là một đoạn trích ví dụ: Đốt ngoài trời. Ủy ban Chất lượng Môi trường Texas, 2015.
Khả năng dự án
Nếu bạn là một linh hồn đủ dũng cảm để viết một tài liệu hướng dẫn, hãy cố gắng tìm một quy định hành chính mà may mắn là ngắn gọn — dưới 10 trang. Dưới đây là một số khả năng:
Xem xét việc chọn và viết về một trong những điều này:
- Chương 361. Đạo luật Xử lý Chất thải Rắn. Cái này đề cập đến các quy định về lốp xe đã qua sử dụng hoặc amiăng của Texas.
- Tái chế dầu đã qua sử dụngỦy ban Chất lượng Môi trường Texas
- Quản lý lốp xe đã qua sử dụng hoặc lốp xe phế thải
- Chương 2201, Quyền anh. Cái này không phải về bìa cacton!
- Chương 2100, Cấp phép, Đăng ký và Vận hành (của tiệm cắt tóc)
- Chương 5300, Hôn Nhân và Liệu Pháp Gia Đình
Thiết kế tài liệu hướng dẫn
Một số gợi ý để viết tài liệu hướng dẫn:
- Nhớ sao chép quy tắc thực tế vào phần phụ lục. Một số tài liệu quy tắc có thể rất dài. Bạn chỉ cần sao chép các phần của quy tắc liên quan trong hướng dẫn của bạn.
- Bao gồm càng nhiều phụ lục càng tốt—đặc biệt là những cái thuộc dạng "chuẩn."
- Trang trí tài liệu hướng dẫn của bạn bằng đồ họa, tiêu đề và tiêu đề phụ, cũng như các tính năng khác để nó trông giống như một tài liệu hướng dẫn thực thụ.
Hướng Dẫn Tài Liệu Sử Dụng AI
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 vài chỉnh sửa. 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 techdocs hoặc các thành phần của nó có thể được tìm thấy trong sách giáo trình viết kỹ thuật trực tuyến.
sắp ra mắt!
Thông tin liên quan
Tài liệu Hướng dẫn. Bộ Nông nghiệp Hoa Kỳ
Cổng Hướng Dẫn HHS. Bộ Y tế và Dịch vụ Nhân sinh Hoa Kỳ
Tôi rất trân trọng ý kiến, phản ứng, và sự phê bình của bạn về chương này: phản hồi của bạn—David McMurrey.
