Một thủ tục giống như một công thức. Một tập hợp các hướng dẫn nêu rõ ai sẽ làm gì, khi nào nên làm, cách thực hiện và kết quả sẽ như thế nào. Liệt kê từng bước theo thứ tự nó phải được hoàn thành. Biên dịch nhiều thủ tục trong một hướng dẫn được tổ chức theo mô tả công việc, bộ phận, chức năng hoặc bất kỳ thứ tự nào làm cho thông tin dễ tiếp cận nhất đối với người dùng của hướng dẫn. Đừng nhầm lẫn chính sách với các thủ tục. Chính sách là quy tắc hoặc tuyên bố về vị trí; thủ tục là những gì mọi người làm theo để thực hiện các chính sách.
Các mặt hàng bạn sẽ cần
-
Tài liệu hiện có có thể là tài liệu
-
Các chuyên gia về chủ đề, những người biết cách thực hiện các thủ tục
Quyết định các thủ tục để tài liệu. Hai phương pháp để chọn nội dung hướng dẫn sử dụng của bạn là khảo sát người dùng thủ công tiềm năng để tìm ra những nhiệm vụ họ cần làm rõ hoặc biết thêm thông tin hoặc bạn có thể muốn lập danh sách các vấn đề vận hành bạn có thể giải quyết bằng các quy trình được xác định rõ ràng.
Thu thập thông tin. Một người đã thực hiện nhiệm vụ là tài nguyên tốt nhất của bạn trừ khi bạn tạo ra các quy trình từ đầu. Xem người thực hiện nhiệm vụ và ghi chú, hoặc yêu cầu người đó viết ra cho bạn tất cả các bước liên quan đến nhiệm vụ, cũng như bất kỳ lời khuyên hoặc cảnh báo nào được học qua kinh nghiệm.
Thiết lập bố cục hướng dẫn của bạn. Một định dạng hai cột làm cho các thủ tục rõ ràng và dễ đọc. Tiêu đề mỗi trang với tên thủ tục, và đặt bên dưới tiêu đề một danh sách hoặc đoạn văn của bất kỳ sự kiện nào mà don GU rơi vào một bước, chẳng hạn như tần suất được thực hiện và các mẹo hoặc cảnh báo. Quy trình nên tuân theo sau đó trong một bảng hai cột.
Viết một bản thảo thô. Trong cột bên trái, liệt kê người chịu trách nhiệm về thủ tục. Trong cột bên phải, liệt kê theo thứ tự các bước mà người đó thực hiện. Nếu thủ tục liên quan đến nhiều người, tất cả họ sẽ có thể thấy rõ nơi họ phù hợp với quy trình và những gì họ cần làm.
Kiểm tra các thủ tục. Nhận ai đó không quen thuộc với các thủ tục để theo dõi họ từ dự thảo. Điều quan trọng là sử dụng một người thiếu kinh nghiệm, vì vậy người đó sẽ không sử dụng bất kỳ phím tắt theo thói quen hoặc bóng đè lên những điểm không rõ ràng mà người đọc khác sẽ không hiểu.
Sửa lại bản nháp. Làm rõ, thêm, xóa và sắp xếp lại các bước cho đến khi bất kỳ ai đọc hướng dẫn có thể làm theo các thủ tục.
Xuất bản hướng dẫn. Bao gồm một bảng nội dung để người đọc có thể nhanh chóng xác định vị trí thủ tục. Thêm một thuật ngữ xác định bất kỳ thuật ngữ nào không phổ biến hoặc cụ thể cho ngành công nghiệp của bạn.
Lời khuyên
-
Đừng sử dụng biến thể từ thanh lịch để làm sinh động chữ viết. "Tiện ích" là tiện ích mọi lúc, không phải là "vật phẩm" hay "thiết bị". Mô tả mọi thứ một cách nhất quán có thể lặp đi lặp lại, nhưng nó cải thiện sự rõ ràng cho độc giả.
