SwipeGuide: Viết hướng dẫn hiệu quả

Làm theo các Nguyên tắc Hướng dẫn Tối giản để tạo ra các Hướng dẫn hiệu quả

Làm theo các nguyên tắc Hướng dẫn Tối giản

1. Đặt mình vào vị trí của người dùng
2. Tập trung vào các nhiệm vụ mà họ thực hiện
3. Chọn phương pháp tiếp cận hướng đến hành động
4. Hỗ trợ nhận diện & giải quyết lỗi
5. Thiết kế để sử dụng tại nơi làm việc, cho việc tham khảo & đào tạo

Tìm hiểu thêm về Mô hình này

Áp dụng chúng trong quy trình xây dựng của bạn

1. Viết nội dung Bước

• Sử dụng dạng hướng dẫn đơn giản nhất: động từ + danh từ
• Thêm thông tin khi cần thiết để thực hiện hành động của Bước
• Sử dụng thể chủ động bất cứ khi nào có thể bằng cách bắt đầu bằng động từ và sử dụng thì hiện tại
• Duy trì sự nhất quán trong toàn bộ hướng dẫn bằng cách sử dụng cùng một từ để mô tả cùng một đối tượng

 2. Viết thông tin bổ sung bên dưới bước của bạn

1. Ghi chú Bước mặc định trong SwipeGuide

• Cảnh báo

  • Sử dụng Cảnh báo cho các bước mà người dùng thường xuyên mắc lỗi và/hoặc lỗi có tác động Cao

• Mẹo
  • Sử dụng Mẹo để cung cấp cho người dùng thông tin bổ sung về bước, chẳng hạn như cách tốt nhất / dễ nhất để người dùng thực hiện một nhiệm vụ
  • Viết Mẹo ở thể chủ động và ngắn gọn
  • Sử dụng liên kết siêu văn bản để người dùng truy cập thông tin từ một hướng dẫn khác hoặc thậm chí thông tin bên ngoài

• Các phương án thay thế
  • Sử dụng Các phương án thay thế cho những bước có nhiều cách để người dùng hoàn thành
  • Viết theo cách tương tự như khi viết bước và làm rõ rằng đây là một cách "khác" để thực hiện cùng một tác vụ
• Khắc phục
  • Sử dụng Khắc phục trong trường hợp người dùng có thể gặp sự cố ở một số bước để mô tả cách họ có thể giải quyết vấn đề trong một bước cụ thể
  • Bắt đầu bằng cách mô tả vấn đề, sau đó viết giải pháp như khi viết bước: tập trung vào hành động và đi thẳng vào vấn đề

2. Ghi chú bước tùy chỉnh

• Thiết bị
  • Ghi rõ thiết bị cần thiết để thực hiện từng tác vụ theo quy trình trong Ghi chú bước tương ứng.
• Vị trí
  • Ghi rõ vị trí của máy móc hoặc thành phần cụ thể được đề cập trong Nội dung bước trên dây chuyền, tại khu vực sản xuất hoặc tại máy nào.
• Công cụ
  • Ghi rõ các công cụ cần thiết để thực hiện từng tác vụ theo quy trình trong Ghi chú bước tương ứng.