Business Analyst cần học gì: chuyên nghiệp khi viết hướng dẫn sử dụng

1. Tại sao Business Analyst cần học cách viết hướng dẫn sử dụng

Trong quá trình triển khai phần mềm, đặc biệt với các phần mềm phức tạp như ERP, việc có một tài liệu hướng dẫn rõ ràng, chính xác sẽ giúp khách hàng hạnh phúc hơn và qua đó giảm thiểu chi phí hỗ trợ và hướng dẫn khách hàng sử dụng phần mềm.

Thông thường khách hàng bị chìm ngập trong bể thông tin và không biết bắt đầu sử dụng tài liệu hướng dẫn sử dụng quá dày và thiếu cấu trúc rõ ràng theo tư duy thông thường của họ, do đó họ sẽ trực tiếp hỏi nhân viên hỗ trợ dịch vụ với rất nhiều câu hỏi lặp đi lặp lại khiến cho khối lượng công việc của bộ phận support tăng rất nhiều dẫn đến giảm năng suất chung.

Do đó mục tiêu tài liệu này giúp người đọc trên cương vị là PO/BA/CS (Product Owner/Business Analysis/Customer Support) hiểu cách viết một tài liệu hướng dẫn sử dụng tốt để có thể bắt đầu quá trình xây dựng tài liệu này phù hợp với khách hàng.

2. Cấu trúc và sự rõ ràng là chìa khóa trong hướng dẫn sử dụng

Cấu trúc là chìa khóa để tiết kiệm thời gian và cấu trúc đó nếu xuất phát từ phía cách hiểu và tư duy của người dùng cuối theo các nghiên cứu về quá trình học tập của con người. Do đó Swipe Guide đã đưa ra một lời khuyên về cấu trúc như sau:

Hệ thống phân cấp SwipeGuide về cách viết và cấu trúc sổ tay

Chúng ta hãy xem xét từng thành phần này một cách chi tiết hơn:

• Guide (Hướng dẫn)

Phần này có thể hiểu là tổng quan về tài liệu hướng dẫn sử dụng, giúp người dùng hiểu được cấu trúc chung của một tài liệu hướng dẫn sử dụng bao gồm cả phần mục lục. Thông qua phần này người dùng sẽ có cách nhìn tổng quan về một tài liệu hướng dẫn sử dụng, biết được cách vận dụng tài liệu này như thế nào.

• Topic (Chủ đề)

Đây là các luồng sử dụng phần mềm thường bắt đầu với những câu hỏi mà người dùng đặt ra khi muốn giải quyết trọn vẹn một vấn đề, một nghiệp vụ của họ mà người dùng quan tâm trực tiếp khi sử dụng một phần mềm. Một topic giúp cho cấu trúc của tài liệu hướng dẫn sử dụng rõ ràng bằng cách nhóm các thao tác có liên quan tới nhau để giúp khách hàng giải quyết trọn vẹn một vấn đề. Các topic thường được tiêu đề dưới dạng câu hỏi “Làm thế nào … “ (“How to …”). Ví dụ “How to get started?”, “How to shut down your computer”

• Instruction (Chỉ dẫn):

Một topic có thể bao gồm một số Instruction khác nhau cho người dùng lựa chọn theo ngữ cảnh và tình huống cụ thể của họ. Ví dụ cho một chủ đề “Làm thế nào để cài đặt iPhone, iPad của bạn” (Set up your iPhone, iPad, or iPod touch) sẽ bao gồm các Instruction sau:

• Nếu bạn chuyển sang sử dụng một điện thoại mới — If you’re switching to a new device.
• Nếu bạn lần đầu sử dụng iPhone — If you’re setting up your first iOS device
• Kết thúc quá trình cài đặt — Finish up

(Tham khảo https://support.apple.com/en-gb/HT202033)

• Step (Bước):

Step là những mô tả chi tiết, diễn giải từng bước thao tác thành một chuỗi các hoạt động để thực hiện một nhiệm vụ nhất định trong Instruction. Sẽ rất tốt và trực quan nếu mỗi step được minh hoạt bằng hình ảnh screenshot và highlight khu vực cần thao tác tương ứng với một step.

Để mô tả một step, bạn nên sử dụng câu khẳng định đơn, ngắn gọn với các động từ đứng đầu như “cài đặt, nhấn, nhấp, đi theo”. Tối đa 10–12 bước được khuyến nghị để hướng dẫn của bạn có hiệu quả. Khi bạn muốn người dùng ghi nhớ một Instruction, bạn nên giới hạn bản thân trong tối đa 5–7 bước.

Ví dụ trong tài liệu hướng dẫn “Làm thế nào để cài đặt iPhone, iPad của bạn” (Set up your iPhone, iPad, or iPod touch)”, với Instruction cho ngữ cảnh “Nếu bạn lần đầu sử dụng iPhone — If you’re setting up your first iOS device” thì sẽ có các 8 step như sau:

• Step 1: Bật điện thoại (Turn on your device)
• Step 2: Nếu bạn sử dụng iOS 11 hoặc mới hơn, hãy sử dụng Quick Start (If you have another device on iOS 11 or later, use Quick Start)
• Step 3: Kích hoạt điện thoại (Activate your device)
• Step 4: Cài đặt Face ID hoặc Touch ID (Set up Face ID or Touch ID and create a passcode)
• Step 5: Khôi phục hoặc chuyển thông tin và dữ liệu cũ (Restore or transfer your information and data)
• Step 6: Đăng nhập với Apple ID (Sign in with your Apple ID)
• Step 7: Cài đặt Siri và các dịch vụ khác (Setup Siri and other service)
• Step 8: Cài đặt đồng hồ (Set up Screen Time)
• Step 9: Bật chế độ cập nhật tự động và cài đặt các tính năng khác (Turn on automatic updates and set up other features)

(Tham khảo Apple Support)

Một Instruction hoặc Step có thể sẽ cần có thông tin bổ sung, trong trường hợp đó bạn có thể sử dụng một trong các loại thông tin bổ sung sau với tiêu đề nêu rõ loại thông tin bổ sung đó:

Thông tin bổ sung về các bước có thể được chia thành bốn biểu tượng, dựa trên lý thuyết về ánh xạ thông tin:

• Warning: Các chú ý về tính an toàn và những điều cần biết trước khi sử dụng.
• Tip: Các thông tin bổ sung chi tiết, các mẹo sử dụng.
• Alternative route: cách khách để có thể giải quyết vấn đề của khách hàng.
• Fixes: Những điều mà khách hàng có thể thao tác sai và cách để sửa chúng

3. Một ví dụ mẫu hướng dẫn sử dụng

• Một Instruction trọn vẹn Hướng dẫn cách “Nướng bánh mỳ” với 6 step để thao tác hoàn thành. Ngoài ra kèm theo một Instruction bổ sung “Cách ăn cho ngon” vào cuối Instruction trên. Ta cũng thấy biểu tượng Warning khi sử dụng với những lưu ý về việc sử dụng an toàn và các trang bị kèm theo.

• Dưới đây là một ví dụ về Guide trong một template hướng dẫn sử dụng đăng tại ArboWebForest với hình dạng trông tựa như một mục lục. Các phần 1.0, 2.0, 3.0 4.0 là các topic với các câu hỏi lớn. Các phần 1.1, 1.2, 2.1, 2.2 tương đương với các Instruction.

• Dưới đây là một ví dụ về Guide đăng trong bài của Screen Steps. Các đầu mục lớn như “Getting Started”, “Getting Data” chính là các topic với các Instruction nhỏ như như “Jump Start Guide for Administrators” hay “Connecting to Data Sources”

5. Ôn tập kiến thức viết hướng dẫn sử dụng

• Bạn hãy liệt kê các thành phần trong cấu trúc của một tài liệu hướng dẫn sử dụng?
• Bạn hãy liệt kê các thành phần bổ sung cho 1 Step hoặc Instruction của một tài liệu hướng dẫn sử dụng?
• Bạn hãy cho biết tại sao một tài liệu hướng dẫn sử dụng cần phải có cấu trúc tốt?
• Bạn hãy cho biết phần Guide trong tài liệu hướng dẫn sử dụng có mục đích gì?
• Bạn hãy cho biết phần Topic trong tài liệu hướng dẫn sử dụng có mục đích gì?
• Bạn hãy cho biết phần Instruction trong tài liệu hướng dẫn sử dụng có mục đích gì?
• Bạn hãy cho biết phần Step trong tài liệu hướng dẫn sử dụng có mục đích gì?
• Bạn hãy cho biết các khuyến cáo để làm phần Step tốt là gì?

Nếu bạn là một IT Business Analyst, ưa thích làm sản phẩm quốc tế trong lĩnh vực bán lẻ - thương mại điện tử! Tham gia Tuyển dụng Business Analyst, môi trường làm việc từ xa, địa điểm tự do, quản lý linh hoạt theo Agile.