[For BrSE] [Writing skills] Viết tài liệu sao cho ai cũng hiểu. Bài 2: Outline cho Proposal

Khi tạo một tài liệu có độ lớn tương đối, cách tốt nhất là nên phác thảo ra outline của toàn thể tài liệu đó trước. Như vậy sẽ giúp cho tài liệu được nhìn nhận tổng quan hơn trước khi bắt đầu viết vào chi tiết. Trong bài viết số 2 này sẽ giới thiệu về cách tạo ra Outline cho tài liệu Proposal sao cho dễ hiểu và dễ đọc.

Bài viết được dịch từ bài gốc tại đây

Các tài liệu dễ đọc thường có cấu trúc phân cấp

Tài liệu dễ đọc và dễ hiểu thì tổng thể thường có cấu trúc phân cấp. Thông thường sẽ phân theo các cấp như sau:

• Các chương (Large headline)
• Các phần (Middle headline)
• Các mục (Sub headline)

Cấu trúc phân cấp là không thể thiếu để phân loại và sắp xếp nội dung của các tài liệu có chứa lượng thông tin phức tạp và lớn. Nhờ vào việc phân cấp, nội dung viết trong mỗi topic sẽ được cố định trong 1 phạm vi nhất định, do đó giúp cho người đọc dễ dàng nắm được trọng tâm của từng topic.

Chúng ta hãy đi qua phương pháp phân cấp. Đầu tiên, hãy chia tài liệu theo các chương (Large headline). Sau đó, chia nhỏ các chương ra theo các phần (Middle headline). Nếu cần thiết, tiếp tục chia nhỏ các phần ra thành các mục (Sub headline). Số lượng các phần được chia ra trong mỗi cấp chỉ nên khoảng từ 5 đến 10. Nếu số lượng phân chia quá lớn, người đọc khó có thể nắm được bức tranh tổng thể của tài liệu.

Cách phân cấp cho tài liệu Proposal

Đối với tài liệu Proposal thì có thể xem xét chia theo các Chương (Large headline) như sau:

1. Các vấn đề liên quan tới hệ thống (tài liệu và thông tin cần thiết để giải thích)

2. Giới thiệu tổng quan hệ thống.

3. Cách thức tiến hành phát triển dự án.

4. Estimation

Tiếp theo, ứng với các Chương ở trên, có thể xem xét chia theo các Phần (Middle headline) như sau:

1. Các vấn đề liên quan tới hệ thống

• Bối cảnh ra đời của hệ thống
• Sự cần thiết của việc triển khai hệ thống
• Mục đích của việc triển khai hệ thống
• Tình hình hiện tại của khách hàng
• Vấn đề cần giải quyết hiện tại
• Hiệu quả, kết quả và mục tiêu khi triển khai hệ thống
• Các vấn đề trong việc triển khai hệ thống
• Phương châm / phương án / phương pháp hiện thực hóa hệ thống
• Phạm vi / lĩnh vực kinh doanh mục tiêu

2. Giới thiệu tổng quan hệ thống

• Cấu tạo của hệ thống
• Business Flow sau khi áp dụng hệ thống
• Chất lượng hệ thống và điều kiện hiệu suất
• Phạm vi phát triển hệ thống

3. Cách thức tiến hành phát triển dự án

• Cách thức để tiến hành phát triển dự án
• Sản phẩm sẽ giao cho khách hàng
• Resource dự án
• Lịch trình phát triển

4. Estimation

• Dự toán chi phí

Proposal dựa trên mong muốn của người đọc

Khi tạo 1 tài liệu Proposal, nên tránh triển khai nội dung dựa trên giả định cũng như những điều mà các kĩ sư quan tâm. Thay vào đó, nên tạo tài liệu với nội dung chủ yếu được xem xét dựa trên những gì khách hàng thực sự mong muốn có trong 1 Proposal.

Các kỹ sư có xu hướng tổ chức thứ tự nội dung xung quanh các vấn đề về mặt kỹ thuật. Ngay từ đầu đã giới thiệu cấu trúc tổng thế của hệ thống, làm cho tài liệu Proposal trong như 1 tài liệu giải thích kĩ thuật vậy. (Ví dụ 1)

Tuy nhiên, đây không phải là một tài liệu hướng khách hàng. Khách hàng thường không ưu tiên các vấn đề kỹ thuật ở giai đoạn đề xuất và thực ra cũng là không quan tâm lắm.

Những gì họ đang tìm kiếm là những người đề xuất phải có được hiểu biết cụ thể về tình hình và vấn đề hiện tại của họ, hiểu được nguyên nhân tại sao lại cần thiết hệ thống này và hệ thống này thực sự yêu cầu những gì. Dựa trên sự hiểu biết này, phía người đề xuất sẽ có thể đưa ra được một giải pháp tối ưu nhất. (Ví dụ 2)

Cái cần viết ra đầu tiên, đó chính là bối cảnh của việc tại sao cần thiết phải triển khai hệ thống này. Sau đó, mô tả mục đích của việc triển khai hệ thống, tình hình hiện tại cũng như các vấn đề của khách hàng, hiệu quả của việc triển khai hệ thống và các mục tiêu cần đạt được, các vấn đề phải giải quyết để thúc đẩy hệ thống hóa. Rõ ràng, các propsal dựa trên lập trường của chính người đọc (khách hàng) sẽ đem lại được sự yên tâm cũng như sự tin tưởng.

Ví dụ 1: Proposal dựa trên quan điểm và tầm nhìn của kĩ sư

1. Tổng quan hệ thống

• Cấu trúc hệ thống
• Business flow sau khi triển khai hệ thống
• Chất lượng hệ thống và điều kiện hiệu suất
• Phạm vi hệ thống
• Sử dụng packet sofware

2. Làm thế nào để tiến hành phát triển dự án

• Làm thế nào để tiến hành phát triển dự án
• Sản phẩm delivery
• Resource dự án
• Lịch trình phát triển

3. Estimation

• Dự toán

4. Vận hành và bảo trì

• Hỗ trợ vận hành
• Hệ thống bảo trì

Ví dụ 2: Proposal dựa trên quan điểm và tầm nhìn của khách hàng

1. Các vấn đề liên quan tới hệ thống

• Bối cảnh ra đời của hệ thống
• Sự cần thiết của việc triển khai hệ thống
• Mục đích của việc triển khai hệ thống
• Tình hình hiện tại của khách hàng
• Vấn đề cần giải quyết hiện tại
• Hiệu quả, kết quả và mục tiêu khi triển khai hệ thống
• Các vấn đề trong việc triển khai hệ thống
• Phương châm / phương án / phương pháp hiện thực hóa hệ thống
• Phạm vi / lĩnh vực kinh doanh mục tiêu

2. Giới thiệu tổng quan hệ thống

• Cấu tạo của hệ thống
• Business Flow sau khi áp dụng hệ thống
• Chất lượng hệ thống và điều kiện hiệu suất
• Phạm vi phát triển hệ thống

3. Cách thức tiến hành phát triển dự án

• Cách thức để tiến hành phát triển dự án
• Sản phẩm sẽ delivery
• Resource dự án
• Lịch trình phát triển

4. Estimation

• Dự toán chi phí

Triển khai theo thứ tự mà khách hàng có thể dễ dàng hiểu được

Khi tạo 1 tài liệu Proposal, phía đưa ra đề xuất thường nghĩ, proposal đương nhiên là để nhằm giải quyết vấn đề của khách hàng. Cho nên khi tạo nôi dung ở phần giới thiệu hệ thống, sẽ thường đi theo thứ thự như sau:

(1) Thiết lập mục tiêu cần đạt được

(2) So sánh tình hình hiện tại với mục tiêu

(3) Làm rõ các vấn đề có thể nhìn thấy từ sự so sánh ở (2)

(4) Trình bày các vấn đề cần khắc phục để giải quyết vấn đề ở (3)

(5) Đề xuất các biện pháp và phương pháp cụ thể

Với suy nghĩ trên, phía đưa ra đề xuất sẽ tạo nội dung phần Giới thiệu hệ thống như ví dụ 3 bên dưới

Ví dụ 3: Triển khai phần "Các vấn đề liên quan tới hệ thống" một cách đột ngột

1. Các vấn đề liên quan tới hệ thống

1.1 Mục đích triển khai hệ thống

1.2 Hiệu ứng, kết quả và mục tiêu khi triển khai hệ thống

1.3 Bối cảnh triển khai hệ thống

1.4 Hiện trạng kinh doanh

1.5 Vấn đề hiện tại

1.6 Các vấn đề trong việc triển khai hệ thống

1.7 Chính sách / biện pháp / phương pháp hiện thực hóa

1.8 Phạm vi / lĩnh vực kinh doanh

Tuy nhiên, việc khách hàng đột ngột được giới thiệu với những gì cần nhắm đến, thì chưa hẳn đã đem lại cảm giác đáng tin tưởng. Kết quả là, đề xuất sẽ được đọc với thiếu đi sự tin tưởng về tính thực tế. Rốt cuộc, chủ trương của người viết lại không được truyền tải đúng.

Thay vào đó, hãy bắt đầu với một câu chuyện cụ thể và thực tế. Nếu chúng ta bắt đầu với một câu chuyện mà khách hàng cảm thấy quen thuộc, việc truyền đạt nội dung có thể trở nên dễ dàng hơn.

(1) Thể hiện trạng thái kinh doanh hiện tại của khách hàng.

(2) Làm rõ các vấn đề hiện tại.

(3) Xuất phát của tầm nhìn (mục đích giới thiệu hệ thống, thành tựu, tác dụng và mục tiêu của việc hệ thống hóa) sau khi giải quyết vấn đề

(4) Chỉ ra các vấn đề (vấn đề triển khai hệ thống) cần khắc phục để đạt được hình dạng mong muốn

(5) Đề xuất các biện pháp (chính sách, biện pháp và phương pháp thực hiện) để đạt được trạng thái lý tưởng

Với luồng suy nghĩ này, nội dung phần "Các vấn đề liên quan tới hệ thống" sẽ như ví dụ 4 bên dưới

Ví dụ 4: Triển khai phần "Các vấn đề liên quan tới hệ thống" từ câu chuyện thực tế.

1. Các vấn đề liên quan tới hệ thống

1.1 Hiện trạng kinh doanh

1.2 Vấn đề hiện tại

1.3 Mục đích triển khai hệ thống

1.4 Hiệu ứng, kết quả và mục tiêu triển khai hệ thống

1.5 Bối cảnh triển khai hệ thống

1.6 Các vấn đề trong triển khai hệ thống

1.7 Chính sách / biện pháp / phương pháp hiện thực hóa

1.8 Phạm vi / lĩnh vực kinh doanh

Suy nghĩ về chức vụ và vị trí của người đọc

Đề xuất là các tài liệu thường được đọc bởi quản lý và các nhà chiến lựợc kinh doanh cấp cao. Việc suy nghĩ trước tới việc này là điều quan trọng.

Quản lý và các nhà chiến lựợc kinh doanh cấp cao yêu cầu các tài liệu kinh doanh trước tiên phải cung cấp một cái nhìn tổng quan và thực chất về những gì người viết muốn trình bày. Tài liệu không có những mô tả này có thể bị bỏ qua tại từ đầu.

Điều tương tự áp dụng cho các đề xuất phát triển hệ thống. Trước hết, cần mô tả tổng quan về các quan điểm tổng thể, những gì bạn muốn tranh luận và tóm tắt các kết luận của bạn.

Ví dụ 5 dưới đây thể hiện về cách viết đột ngột đi vào chủ đề chính.

Ví dụ 5

1. Các vấn đề liên quan tới hệ thống

1.1 Hiện trạng kinh doanh

1.2 Vấn đề hiện tại

1.3 Mục đích triển khai hệ thống

1.4 Hiệu ứng, kết quả và mục tiêu triển khai hệ thống

1.5 Bối cảnh triển khai hệ thống

1.6 Các vấn đề trong triển khai hệ thống

1.7 Chính sách / biện pháp / phương pháp hiện thực hóa

1.8 Phạm vi / lĩnh vực kinh doanh

Thay vì đó, hãy mô tả đề cương và kết luận của proposal như một lời giới thiệ như Ví dụ bên dưới Ví dụ 6

Giới thiệu Tóm tắt và kết luận về đề xuất này

1. Các vấn đề liên quan tới hệ thống

1.1 Hiện trạng kinh doanh

1.2 Vấn đề hiện tại

1.3 Mục đích triển khai hệ thống

1.4 Hiệu ứng, kết quả và mục tiêu triển khai hệ thống

1.5 Bối cảnh triển khai hệ thống

1.6 Các vấn đề trong triển khai hệ thống

1.7 Chính sách / biện pháp / phương pháp hiện thực hóa

1.8 Phạm vi / lĩnh vực kinh doanh

Ngoài ra, trình bày những gì bạn muốn tranh luận và kết luận cũng là một cách hiệu quả để truyền đạt những suy nghĩ và suy nghĩ của bên đề xuất cho người đọc một cách dễ dàng.

Mở rộng ra các góc nhìn khác nhau

Sau khi đưa ra đề xuất, nếu có thể, hãy đưa ra các ví dụ về các trường hợp đã áp dụng hệ thống tương tự. Điều này khiến cho người đọc củng cố thêm niềm tin về việc hiện thực hoá đề xuất này.

Ví dụ có thể mô tả trường hợp của một công ty A đã được triển khai hệ thống, đặc biệt là tổng quan về hệ thống, chi phí phát triển nếu có thể và tác động của việc triển khai hệ thống.

Phần ví dụ này có thể đưa vào cuối cùng của bản đề xuất như một loại thông tin tham khảo.

Hoàn thiện Outline của Proposal

Bài viết này đã giải thích các điểm chính quan trọng để tạo ra một outline cho các proposal nhằm truyền đạt tới khách hàng. Tất cả những điểm này đều phù hợp với ý tưởng của việc "Nghĩ về khách hàng và nhìn vào khách hàng" để đưa ra đề xuất. Bao gồm các ý chính:

• Proposal dựa trên mong muốn của người đọc
• Triển khai theo thứ tự mà khách hàng có thể dễ dàng hiểu được
• Suy nghĩ về chức vụ và vị trí của người đọc
• Mở rộng ra các góc nhìn khác nhau

Outline hoàn thiện dựa trên tư duy này sẽ tương tự như bên dưới

Giới thiệu Tóm tắt và kết luận về đề xuất này

1. Các vấn đề liên quan tới hệ thống

1.1 Hiện trạng kinh doanh

1.2 Vấn đề hiện tại

1.3 Mục đích triển khai hệ thống

1.4 Hiệu ứng, kết quả và mục tiêu triển khai hệ thống

1.5 Bối cảnh triển khai hệ thống

1.6 Các vấn đề trong triển khai hệ thống

1.7 Chính sách / biện pháp / phương pháp hiện thực hóa

1.8 Phạm vi / lĩnh vực kinh doanh

2. Giới thiệu tổng quan hệ thống

2.1 Cấu tạo của hệ thống

2.2 Business Flow sau khi áp dụng hệ thống

2.3 Chất lượng hệ thống và điều kiện hiệu suất

2.4 Phạm vi phát triển hệ thống

3. Cách thức tiến hành phát triển dự án

3.1 Cách thức để tiến hành phát triển dự án

3.2 Sản phẩm sẽ delivery

3.3 Resource dự án

3.4 Lịch trình phát triển

4. Estimation

4.1 Dự toán chi phí

5. Ví dụ giới thiệu về các công ty hàng đầu khác

5.1 Hiệu quả khi triển khai hệ thống tương tự của công ty A

5.2 Hiệu quả khi triển khai hệ thống tương tự của công ty B

5.3 Hiệu quả khi triển khai hệ thống tương tự của công ty C

Tóm lại, một khi proposal không được tạo ra với thái độ "Nghĩ về khách hàng và nhìn vào khách hàng", thì khó lòng để cho proposal này trở thành một proposal được khách hàng đọc, thấu hiểu nội dung, đồng cảm và chấp nhận đề xuất. Đó chính là điểm mấu chốt quan trọng nhất.

Xin cảm ơn.