Kỹ năng tạo tài liệu dễ hiểu

Hẳn các bạn đã nghe nhiều về cụm từ "Writing skill" - Kỹ năng viết.

Có thể nói một trong những công việc quen thuộc nhất của BRSE là tạo tài liệu (tài liệu estimate, spectifications, schedule,...)

Do đó, để trở thành một BRSE giỏi bạn cần rèn luyện kỹ năng tạo tài liệu của mình.

Làm thế nào để tạo một tài liệu đầy đủ thông tin nhưng không bị rối mắt, đọc dễ hiểu và trình bày đẹp?

Làm thế nào để tạo một tài liệu có thể update dễ dàng mà ko cần tốn nhiều công sức?

Tất cả những điều này bạn cần phải học, để ý từng chút, cộng thêm vài tip của người đi trước sẽ giúp bạn hình thành kỹ năng viết tốt.

Muốn tạo được tài liệu tốt trước tiên phải biết người đọc cần thông tin gì

Chắc hẳn các bạn đã từng nghe qua câu chuyện có 2 anh nhân viên A và B.

Cả 2 đều nhận được chỉ thị từ sếp rằng "Hãy ra chợ và hỏi giá dưa hấu".

Anh A đi 5 phút sau đã trở lại, nhưng ngoài giá dưa hấu ra anh chẳng có thêm thông tin gì.

Anh B đi 30 phút sau quay lại, anh không những điều tra về giá dưa hấu mà còn clear rõ ràng đó là giá dưa hấu loại nào, những loại khác có giá như thế nào, vì sao lại có mức giá ấy,...

Việc tạo tài liệu cũng giống như vậy.

Có thể bạn nhận được yêu cầu là ABC và bạn đưa ra câu trả lời là XYZ.

Nhưng như vậy là chưa đủ. Bạn cần phải giải thích vì sao lại đưa ra kết luận XYZ, nguồn tham khảo ở đâu,...

Một ví dụ đơn giản:

Requirement: Hãy cho tôi biết những task nào đang làm dở, những task nào chưa bắt tay vào làm. Dự định khi nào thì làm xong?

Bạn định tạo file với những thông tin gì? List task đang làm dở, List task chưa bắt đầu làm, Ngày dự định hoàn thành?

Nếu là mình, với một requirement như vậy mình sẽ làm những công việc sau:

• Đưa ra thông tin mà khách cần Mục đích của requirement trên cuối cùng vẫn là nắm được những công việc còn lại là gì? Bao giờ thì sẽ hoàn thành xong.
• Cơ sở để đưa ra những thông tin ấy

Do đó mình sẽ tạo 1 file với các thông tin sau:

• Tổng số effort
• Số effort đã burn
• Số effort còn lại
• List các task đang làm dở, effort của task ấy, ngày dự định hoàn thành
• List các task chưa bắt đầu làm, effort của task ấy, ngày dự định hoàn thành
• Cột note để ghi các điều cần chú ý
• Resource plan cần thiết cho đến khi hoàn thành xong các task còn lại

Tài liệu phải được update một cách dễ dàng và không tốn nhiều công sức

Tùy theo nhu cầu sử dụng, đôi khi chúng ta phải update lại những tài liệu đã tạo từ đầu. Vậy làm thế nào để công việc update được thực hiện nhanh, gọn, dễ dàng?

Có một số tip sau đây:

1. Nếu có thể dùng công thức thì hãy dùng công thức Với những tài liệu thiên về cung cấp con số dữ liệu (như estimate, tiến độ,...) thì hãy cố gắng dùng công thức tính toán, không nên input tay. Bởi vì dùng công thức thì khi bạn thay đổi 1 cột, các cột liên quan sẽ tự động được update theo thay vì phải update lại từng cột.

2. Nếu một nội dung được sử dụng nhiều lần thì chỉ viết một lần và cho tham chiếu đến Hãy thử nghĩ xem nếu nội dung ấy bị thay đổi thì bạn chỉ cần sửa một lần thôi, thay vì phải ngồi sửa lại tất cả những chỗ đang sử dụng

Đừng tạo tài liệu với suy nghĩ "người đọc phải biết kiến thức trong ngành"

Một tài liệu dễ hiểu là một tài liệu dù không phải là người có kiến thức trong ngành thì khi xem tài liệu ấy vẫn hiểu được.

1. Không dùng quá nhiều thuật ngữ trong ngành

Thuật ngữ ngành sẽ gây khó khăn khi người xem không có kiến thức về ngành nghề đó. Thay vì dùng thuật ngữ, hãy dùng ngôn ngữ thông thường để diễn giãi nó.

2. Không viết vắn tắt

Nếu bạn viết quá đơn giản, ngắn ngọn thì sẽ gây khó hiểu.

Ví dụ1:

Khi estimate task một bạn dev thẳng thừng khi con số 40h cho task ấy.

Tôi không phải dev nên tôi không biết cái task ấy khó hay dễ, phải làm những gì. Tôi chỉ nhìn vào con số 40h là con số khá lớn và tôi bắt đầu suy nghĩ "có thật là cái task ấy ngốn những 40h không?"

Thay vào đó hãy break task ra và giải thích cụ thể để làm task ấy thì mình làm những công việc gì, mỗi công việc tốn bao nhiêu effort.

Người xem sẽ hiểu và dễ chấp nhận.

Ví dụ 2:

Có một bạn dev viết daily report chỉ một câu vẻn vẹn "Research abc"

Tôi chẳng biết được cái abc đấy được dùng để làm gì và vì sao phải research.

3. Focus on the point

Đây là vấn đề muôn thuở mà tôi từng gặp. Đọc một đoạn văn khá dài nhưng cuối cùng vẫn không hiểu người viết muốn nói gì. Hoặc là cả một đoạn văn dài thực chất chỉ cần diễn tả bằng một câu là được.

Tạo tài liệu dễ xem

Tạo được một tài liệu dễ hiểu xem như bạn đã hoàn thành 50% công việc. Phần còn lại là phải làm cho tài liệu của bạn dễ xem. Thế nào là dễ xem?

Dễ xem tức là các thông tin bạn trình bày không bị rối, không phải tốn quá nhiều công để xem. Có một số tip như sau:

1. Nếu nội dung trong một cell quá dài đừng cố kéo dài cell đó ra để viết cho đầy đủ nội dung.

Hãy viết nội dung đó trên nhiều cell với độ dài cell vừa phải. Vì sao phải làm như thế này ư?

Bạn hãy trên excel và sẽ thấy sự khác biệt. Viết hết tất cả nội dung vào 1 cell khi bạn scroll sẽ mất đầu, mất đuôi, khi xem sẽ rất khó chịu. Chia ra nhiều cell, mỗi cell là một nội dung hoàn chỉnh thì khi bạn scroll sẽ xem hết được nội dung trong từng cell mà không bị cắt giữa chừng.

2. Khi merge hãy nghĩ tới việc dùng filter

Thường thì người xem hay dùng chức năng filter để xem những thông tin mình muốn (Ví dụ trong file quản lý task chỉ muốn xem các task chưa hoàn thành chẳng hạn)

Nếu merge cell sẽ không dùng được filter nữa, hãy cân nhắc trước khi merge.

3. Sử dụng màu sắc

Hãy cân nhắc đến việc sử dụng màu sắc. So với một file toàn trắng đen thì việc gắn màu để phân việt trạng thái cũng giúp người xem nắm bắt nội dung một cách trực quan hơn.

Ví dụ trạng thái Done là màu xanh, Late là màu đỏ chẳng hạn.

Bạn có thể dùng chức năng fortmat theo điều kiện để làm việc này.

4. Luôn có một sheet summary với các loại tài liệu cung cấp con số dữ liệu

Tài liệu cung cấp con số dữ liệu thường chứa rất nhiều thông tin và người xem không thể nhớ hết được

Hãy tạo một sheet summary để người dùng xem được các thông tin kết luận hoặc có thể filter để lấy thông tin theo một điều kiện nào đó

Ví dụ: Bạn tạo tài liệu thống kê công việc mỗi tháng.

Ngoài mỗi sheet tương ứng với mỗi tháng ra, nên tạo một sheet summary với biến là thời gian. Tại sheet summary này người xem chỉ cần nhập vào thời gian mà họ muốn kiểm tra công việc, nội dung tương ứng với thời gian đó sẽ được hiển thị chẳng hạn.