Mẹo giúp Business Analyst viết tài liệu tốt hơn

Nếu bạn là một Business Analyst, chắc chắn bạn quen thuộc với việc viết tài liệu. Vậy, bạn có gặp phải những tình huống sau:

• Tài liệu quá dài, quá nặng
• Bạn cảm thấy mình viết dễ hiểu nhưng team của bạn không hiểu và yêu cầu bạn giải thích.
• Người đọc thấy đã hiểu nhưng không chắc chắn nên hỏi lại bạn.
• Mỗi người đọc hiểu một ý khác nhau.

Nếu bạn gặp phải một trong những tình huống trên, có thể bạn sẽ cần cải tiến một chút về cách viết tài liệu. Cùng tham khảo những vấn đề và những gợi ý cải thiện sau đây nhé!

1. Đối tượng đọc tài liệu

Vấn đề

• Không rõ mục đích của tài liệu là gì, viết cho ai?
• Viết 1 tài liệu cho nhiều loại đối tượng khác nhau: Business Owner, Develop team, Training team,..

Mẹo

Trước khi viết tài liệu, BA cần xác định tài liệu này sẽ viết cho ai và với mục đích gì, nhằm đạt được gì. Từ đó BA xác định loại tài liệu sẽ viết BRD, FSD, SRS,… và xác định được nội dung chính, cách thể hiện nội dung và từ ngữ, cũng như lối viết trong tài liệu.

2. Template

Mẹo

• Trước tiên hãy hỏi leader về template tài liệu của team/công ty để tiết kiệm thời gian và đảm bảo chất lượng.
• Trường hợp công ty không có template, hãy dành thời gian để suy nghĩ về đối tượng đọc tài liệu, nội dung chính và hình thức sẽ viết trong tài liệu để tạo ra một template tối ưu nhất có thể. Tất nhiên việc này có thể sẽ chưa chuẩn chỉnh ngay từ template đầu tiên, việc tiếp theo của bạn là theo dõi và điều chỉnh đến khi bạn thấy phù hợp nhất.

3. ngôn ngữ và từ ngữ

Mẹo

• Thống nhất ngôn ngữ trong tài liệu. Ví dụ bạn đang viết tài liệu gửi khách hàng người Việt đọc, thay vì viết “hiển thị popup xác nhận thông tin trước khi lưu”; bạn hãy viết “hiển thị giao diện xác nhận thông tin trước khi lưu”.
• Hạn chế dụng các từ như: “sẽ”, “có thể”, “nên”; bạn nên sử dụng câu khẳng định. Ví dụ: Hệ thống cho phép người dùng xem thử bài viết trước khi xuất bản.
• Sử dụng từ phù hợp với đối tượng người đọc
  • khi viết tài liệu để các phòng ban kinh doanh xác nhận yêu cầu, không nên viết nội dung và từ ngữ liên quan đến kỹ thuật như “hệ thống sẽ call API”,”popup”,…
  • khi viết tài liệu cho development team, hãy hạn chế sử dụng thuật ngữ chuyên ngành của domain trừ khi đó là đặc thù không có từ khác thay thế, hãy viết từng câu ngắn gọn súc tích mô tả yêu cầu.

4. Mô tả quy trình

Vấn đề: giải thích khái niệm, mô tả quy trình bằng các đoạn văn dài thật dài.

Mẹo

• Cách hiệu quả nhất để giải thích một khái niệm, quy trình đó chính là đưa vào một sơ đồ, nó giúp người đọc dễ hiểu hơn rất nhiều.
• Bạn có thể mô phỏng và ví dụ các khái niệm chuyên môn, đặc thù hoặc phức tạp ở dạng bảng, hình ảnh, sơ đồ, biểu đồ.
• Luôn chia tài liệu thành các quy trình nhỏ hơn để dễ đọc hơn.

5. sơ đồ

Vấn đề: một sơ đồ “đồ sộ” chưa chắc đã truyền đạt được đúng và đủ thông tin. Một sơ đồ gồm quá nhiều quy trình nhỏ, tất cả quy trình nhỏ đều được rã chi tiết, các đường đi/mũi tên chồng chéo lên nhau. Một sơ đồ như thế chỉ làm cho người đọc “rối não” và không tập trung được.

Mẹo

• Hãy nhớ đến mục đích của sơ đồ, tài liệu này dùng để làm gì, dành cho đối tượng nào. Từ đó BA lựa chọn mức độ truyền đạt phù hợp (tổng thể đến chi tiết).
• Tách từng quy trình nhỏ là 1 sơ đồ, đảm bảo sơ đồ không quá phức tạp, không quá dài.
• Hạn chế các đường đi/ mũi tên quay ngược quá nhiều và chồng chéo lên nhau.
• Sơ đồ không nhất định phải là các khối hình học và chữ, bạn có thể sử dụng hình ảnh và highlight vào hình để diễn tả luồng đi.

6. Cách viết tài liệu rối não người đọc

Vấn đề: viết dưới dạng một đoạn văn gồm nhiều câu, nhiều ý, cả trăm cái dấu phẩy; một đoạn văn dài lê thê làm người đọc không rõ ý chính đang đề cập là gì.

Mẹo

Luôn chia thành các câu ngắn hơn.

• Tách bạch các câu rõ ràng bởi dấu chấm, tốt nhất mỗi câu nên được xuống dòng.

• Tách bạch mỗi ý là một dòng, ngắn gọn, nếu cần thì sắp xếp theo thứ tự từ trên xuống. Ví dụ: khi mô tả hệ thống cần kiểm tra các thông tin nào (theo thứ tự) trước khi lưu

• Sử dụng bullet, highlight keyword trong câu

7. hình ảnh minh hoạ

Vấn đề: sử dụng hình ảnh minh hoạ nhưng chứa những thông tin không liên quan đến nội dung đang mô tả.

Mẹo

• Hình ảnh chỉ chứa nội dung liên quan đến phần đang mô tả. Nếu có chứa những thông tin khác thì nên highlight thông tin đang mô tả.
• Bạn cũng có thể sử dụng hình ảnh để diễn tả luồng quy trình, hãy nhớ luôn highlight nội dung chính của từng bước.

8. Xem thường các sai sót nhỏ

Vấn đề: sẽ không thể tránh khỏi các sai sót nhỏ, điển hình là lỗi chính tả hoặc không chia sẻ quyền xem trước khi gửi. Nhưng nếu xảy ra quá nhiều sẽ làm cho người đọc khó chịu, nếu đối tượng đọc là khách hàng sẽ ảnh hưởng đến hình tượng chuyên nghiệp của bạn và công ty.

Mẹo

Rà soát tài liệu trước khi cho người khác xem.

• Đảm bảo sơ đồ chính xác
• Kiểm tra lỗi chính tả và ngữ pháp
• Kiểm tra các định dạng
• Kiểm tra quyền chia sẻ.
• Kiểm tra đúng và đủ ý chưa.

9. Tất cả trong một tài liệu là hoàn hảo nhất

Vấn đề: việc viết tất cả các quy trình/ phân hệ/ hệ thống trong một tài liệu cũng là một phần làm cho tài liệu dài và nặng. Thử nghĩ bạn mở ra một tài liệu dài và load chậm liệu bạn có muốn đọc tiếp không? Nếu là công việc nên phải đọc, vậy chắc chắn bạn sẽ “bỏ sót”/”hiểu nhầm ý” vì mệt!

Mẹo

• Xem xét đến việc tách nhỏ mỗi quy trình là một tài liệu. Điều kiện để tách nhỏ có thể dựa vào: đối tượng đọc khác nhau (khác nhóm phát triển), khác hệ thống, khác nhóm tính năng,….
• Để liên kết các tài liệu này với nhau bạn hãy link chúng với nhau ở mỗi tài liệu. Hoặc tạo 1 tài liệu quy trình lớn tập hợp tất cả các link tài liệu của các quy trình nhỏ.

10. hãy đọc lại tài liệu của mình

Đọc lại tài liệu mà mình đã viết cũng là cách để bạn đặt mình ở vai trò là người đọc, tự đánh giá xem viết như thế có dễ đọc, dễ hiểu hay chưa. Việc này có thể bạn sẽ phải thực hiện nhiều lần:

• Sau khi viết xong và trước khi gửi ra: để đảm bảo đúng và đủ ý, tránh các sai sót. Lúc này bạn có thể chỉnh sửa một số câu/ hình thức dài dòng, khó hiểu.
• Sau khi gửi ra: hãy ghi nhận các phản hồi, bình luận hoặc câu hỏi của người đọc và cập nhật tài liệu nếu cần. Trong quá trình cập nhật tài liệu, bạn cũng nên tìm cách đánh giá và chỉnh sửa cho dễ hiểu hơn.
• Sau khi bạn đã “quên”: sau vài ngày hoặc lâu hơn một chút, hãy đọc lại các tài liệu mình đã viết. Có thể khi đó bạn sẽ có suy nghĩ “tại sao lúc trước mình có thể viết phức tạp như này được nhỉ?”, và tin tôi đi chính những lúc như này bạn sẽ có những sáng kiến để viết tài liệu hay hơn.

Đúc kết lại, hãy nhớ luôn thực hiện 3 điều sau đây để phát triển khả năng viết tài liệu nhé:

1. Phân tích: phân tích đối tượng đọc, nội dung cần thể hiện để lựa chọn template và lối viết phù hợp.
2. Đánh giá hiệu quả: bằng các cách gợi ý trong mục 10, bạn hãy đưa ra những điều cần cải thiện trong cách viết của mình.
3. Cải thiện: luôn cập nhật tốt hơn, và tiếp tục vòng lặp Phân tích – Đánh giá – Cải thiện.

Điều cuối cùng, hãy nhớ rằng bạn không thể mới viết đã tốt, nhưng bạn có thể viết tốt hơn. Với các mẹo trên hy vọng có thể giúp cho các BA có thể viết tài liệu hiệu quả hơn!