Kiểm tra nội dung
Một trong những cách quan trọng nhất để bạn xem xét một bản nháp thô là kiểm tra nội dung—thật hiển nhiên! Tất cả các chuyển tiếp tốt, tổ chức tốt và cấu trúc câu rõ ràng trên thế giới cũng không thể giúp một tài liệu kỹ thuật không có nội dung phù hợp. Nội dung của một tài liệu kỹ thuật có thể "sai" theo nhiều cách:
- Nó có thể hoàn toàn thiếu: ví dụ, hãy tưởng tượng rằng ai đó đã viết một báo cáo về "các cộng đồng ảo" nhưng không bao giờ bận tâm định nghĩa thuật ngữ đó có nghĩa là gì. Sẽ rất khó khăn ngay từ đầu báo cáo đó.
- Nó có đó nhưng chưa đủ: lấy cùng một ví dụ — tưởng tượng rằng tác giả chỉ đưa ra một vài nhận định mơ hồ về các cộng đồng ảo. Điều cần thiết là ít nhất một đoạn về chủ đề này, nếu không muốn nói là một phần dài 3 hoặc 4 trang.
- Nó có đó nhưng ở mức không phù hợp với khán giả: Cũng có thể truyền đạt thông tin ở mức không phù hợp với kiến thức, nền tảng hoặc nhu cầu của độc giả. Hãy tưởng tượng rằng người viết đã bao gồm một phần 3 trang về caching dữ liệu nhưng viết cho các nhà phát triển sản phẩm (một khán giả "chuyên gia") trong khi báo cáo thực sự nhằm vào những người không chuyên.
Nếu bạn có thể nhận ra thông tin trong bản thảo báo cáo là không đầy đủ, bạn sẽ đi đúng hướng để biết cụ thể cần làm gì để chỉnh sửa. Một công cụ động não hữu ích là suy nghĩ theo các yếu tố các loại nội dung.
Sử dụng các câu hỏi được cung cấp trong nội dung tài liệu để xem xét bản nháp của bạn về các loại thông tin cần thêm hoặc thay đổi.
Kiểm tra cấu trúc nội dung của bạn.
Có hai cách nhìn vào tổ chức thông tin trong một tài liệu:
- Một, được trình bày trong phần tiếp theo, liên quan đến việc xem xét chuỗi các khối thông tin, xem chúng có được sắp xếp theo đúng thứ tự hay không.
- Một điều khác liên quan đến các cấp độ thông tin. Bạn có thể nhìn vào các câu hoặc đoạn trong một bản thảo thô và thấy rằng một số câu đi sâu hơn vào vấn đề so với những câu khác. Những câu khác lại đóng vai trò như khung mà các câu ở cấp độ sâu hơn phụ thuộc vào. Bằng cách xem xét cấu trúc theo cách này, bạn không chỉ kiểm tra sự tổ chức mà còn thu được nhiều ý tưởng hay để cải thiện nội dung của văn bản.
Một giải thích chi tiết hơn được cung cấp tại sự phối hợp và sự phụ thuộc trong các đoạn văn.
Kiểm tra tổ chức
Nếu bạn có nội dung đúng trong một báo cáo, ít nhất bạn đã có tất cả các "đồ đúng" có sẵn cho độc giả. Tuy nhiên, nó vẫn có thể không được tổ chức hợp lý—như khi bạn vừa chuyển nhà và mọi thứ đều lộn xộn hoặc vẫn còn trong hộp. Bạn cần hai kỹ năng thiết yếu để xem xét tổ chức của một bản thảo thô:
- Xác định chủ đề của các khối thông tin ở nhiều cấp độ khác nhau. Để đánh giá cách tổ chức của một chuỗi đoạn văn, bạn bắt đầu bằng cách suy nghĩ về một từ hoặc cụm từ để xác định chủ đề của mỗi đoạn—nói cách khác, nắm bắt từng cái một. Sau đó, bạn lùi lại từ những từ hoặc cụm từ đó, xem xét liệu chúng có ở đúng thứ tự hay không. Tuy nhiên, đó chỉ là một cấp độ. Bạn cũng có thể nhìn trong phạm vi một đoạn văn riêng lẻ cho việc tổ chức của nó. Trong trường hợp này, bạn xác định chủ đề của từng câu và xem xét thứ tự của những câu đó.
- Chọn chuỗi tốt nhất cho các khối thông tin. Khi bạn biết chủ đề của từng phần thông tin (ở bất kỳ cấp độ nào bạn đang điều tra), bạn có thể quyết định xem chúng có đúng thứ tự hay không. Quyết định này liên quan đến việc biết các mẫu sắp xếp chung; đây là một số ví dụ:
- Tổng quát → cụ thể: Một cách tổ chức phổ biến là sắp xếp các phần nội dung từ chung đến cụ thể. Ví dụ, định nghĩa tất cả Bộ thu năng lượng mặt trời là một cuộc thảo luận tổng quát hơn so với việc thảo luận về các loại bộ thu năng lượng mặt trời khác nhau. Và mô tả hoạt động của một loại bộ thu năng lượng mặt trời cụ thể còn kém tổng quát hơn. Mẫu hình này được minh họa ở đây:
Sửa đổi theo cấu trúc tổ chức từ tổng quát đến cụ thể. Đó là một tiến trình tự nhiên hơn khi bắt đầu bằng cách xác định những gì tất cả các bộ thu năng lượng mặt trời đều làm, sau đó chuyển đến các loại khác nhau của chúng. - Đơn giản, cơ bản → phức tạp: Một cách khác để sắp xếp các phần của một cuộc thảo luận là bắt đầu với những phần đơn giản, cơ bản, nền tảng và sau đó chuyển sang những phần phức tạp hơn và kỹ thuật hơn.
- Đối tượng tĩnh → đối tượng chuyển động: Một mô hình tổ chức khác liên quan đến việc đầu tiên mô tả sự vật (như trong một bức ảnh), sau đó thảo luận về hoạt động hoặc quy trình của nó (như trong một video). Cách tiếp cận này có thể hoạt động tốt cho một cuộc thảo luận về hệ thống phun nhiên liệu.
- Chuyển động không gian: — Nếu bạn đang mô tả các chi tiết vật lý của một cái gì đó, bạn có thể muốn sử dụng một số mẫu chuyển động vật lý, ví dụ, từ trên xuống dưới, từ trái sang phải, hoặc từ ngoài vào trong.
- Di chuyển tạm thời: — Một trong những mô hình phổ biến nhất dựa trên chuyển động qua thời gian; sắp xếp cuộc thảo luận về các sự kiện liên quan đến trình tự tạm thời.
- Khái niệm → ứng dụng của khái niệm, ví dụMột mô hình tổ chức phổ biến là thảo luận về một khái niệm theo cách tổng quát, sau đó thảo luận về một ứng dụng của nó. Chẳng hạn, một chương khác trong cuốn sách này thảo luận về các đề xuất trước tiên một cách khái niệm, sau đó thảo luận về các ví dụ về các đề xuất.
- Kết luận dữ liệu →: Một cách tổ chức thông tin khác là trình bày dữ liệu (quan sát, dữ liệu thí nghiệm, kết quả khảo sát) sau đó chuyển sang các kết luận có thể rút ra từ dữ liệu đó. (Và mô hình này đôi khi được đảo ngược: trình bày kết luận trước, sau đó là dữ liệu hỗ trợ cho nó.)
- Vấn đề, câu hỏi → giải pháp, câu trả lời: Bạn cũng có thể tổ chức thông tin bằng cách đầu tiên thảo luận về một vấn đề hoặc nêu ra một câu hỏi, rồi sau đó chuyển sang giải pháp hoặc câu trả lời.
- Phiên bản đơn giản → phiên bản chi tiết: Một cách hữu ích để giải thích các vấn đề kỹ thuật cho những người không chuyên là bắt đầu bằng việc thảo luận về một phiên bản đơn giản của vấn đề, thiết lập sự hiểu biết vững vàng về nó, sau đó quay lại và giải thích tất cả một lần nữa nhưng lần này với những chi tiết kỹ thuật dày đặc và nặng nề!
- Quan trọng nhất → ít quan trọng nhất: Một phương pháp tổ chức "tốp" hơn là bắt đầu với thông tin quan trọng nhất, hấp dẫn nhất, kịch tính nhất trước, sau đó chuyển sang thông tin ngày càng ít quan trọng hơn. (Và mô hình này có thể đảo ngược: bạn có thể xây dựng lên cao trào, chứ không phải bắt đầu với nó.)
- Thuyết phục nhất → kém thuyết phục nhất: — Tương tự, bạn có thể bắt đầu với lập luận thuyết phục nhất cho vị trí của mình — để thu hút sự chú ý của mọi người — rồi sau đó chuyển sang những lập luận ít thuyết phục hơn. (Mô hình này cũng có thể được đảo ngược: bạn có thể xây dựng lên từ những lập luận thuyết phục nhất của mình.)
- Tổng quát → cụ thể: Một cách tổ chức phổ biến là sắp xếp các phần nội dung từ chung đến cụ thể. Ví dụ, định nghĩa tất cả Bộ thu năng lượng mặt trời là một cuộc thảo luận tổng quát hơn so với việc thảo luận về các loại bộ thu năng lượng mặt trời khác nhau. Và mô tả hoạt động của một loại bộ thu năng lượng mặt trời cụ thể còn kém tổng quát hơn. Mẫu hình này được minh họa ở đây:
Đây chỉ là một vài khả năng. Khi mục đích là cung cấp thông tin, bạn sắp xếp thông tin sao cho đảm bảo rằng người đọc hiểu những điều cơ bản trước khi chuyển sang những vấn đề phức tạp, kỹ thuật. Khi mục đích là thuyết phục, bạn sắp xếp mọi thứ để tối đa hóa hiệu ứng thuyết phục đối với người đọc, chẳng hạn như bằng cách đặt những lập luận mạnh nhất lên đầu.
Và trong mọi trường hợp, bạn nên tránh việc trộn lẫn các phương pháp này—ví dụ, loại bỏ một số dữ liệu, rồi đưa ra một vài kết luận, và sau đó lại làm đi làm lại một cách tùy tiện. Hãy giữ táo tách biệt với cam!
Củng cố câu chủ đề và tổng quan
Một trong những điều tốt nhất bạn có thể làm là quay lại bản thảo thô và kiểm tra xem bạn có thể chèn các câu chủ đề và tổng quan tại những điểm quan trọng hay không. Khi chúng ta viết, chúng ta thường không chắc chắn chính xác đoạn văn hoặc phần nào đang đi đến đâu về nội dung và logic. Khi nó đã "đến đó," thường thì cần phải quay lại đầu và thêm một loại tổng quan nào đó hoặc chỉnh sửa những gì đã có để làm cho tổng quan rõ ràng hơn. Bạn đọc cần biết họ đang đi đâu trong một báo cáo, điều gì sẽ đến tiếp theo, và ở khía cạnh đó, họ vừa ở đâu.
Có một cái nhìn tổng quan trong một báo cáo giống như có một bản đồ khi bạn ở trong một thành phố mới. Câu chủ đề và cái nhìn tổng quan cung cấp một góc nhìn về những gì ở đâu: chủ đề, các chủ đề phụ, mục đích của cuộc thảo luận sắp tới, mối quan hệ của nó với phần trước và với toàn bộ tài liệu. (Bây giờ một số phần này liên quan đến chuyển tiếp, đó là yếu tố tiếp theo cần xem xét.)
Để biết thông tin chi tiết về chủ đề này, xem câu chủ đề và tóm tắt.
Tăng cường sự liên kết, chuyển tiếp.
Bạn có thể có thông tin đúng trong một báo cáo và tổ chức nó hợp lý, nhưng vẫn có thể xảy ra điều gì đó quan trọng. Người đọc có thể bỏ lỡ "dòng chảy" của các ý tưởng, gặp khó khăn trong việc cảm nhận cách mà các phần thông tin liên quan hoặc kết nối với nhau. Những gì người đọc cần là sự hướng dẫn liên tục—điều mà bạn, người viết, cung cấp. Và những gì bạn sử dụng để cung cấp hướng dẫn đó được gọi là các chuyển tiếp—các thiết bị khác nhau giúp người đọc đi qua một tài liệu. Có (hoặc chắc chắn nên có) một logic kết nối mọi câu trong một tài liệu và điều đó quyết định một thứ tự nhất định cho những câu đó.
Xem chương về tính nhất quán và chuyển tiếp để thảo luận chi tiết và ví dụ.
Kiểm tra độ dài đoạn văn
Một cách cuối cùng để xem lại bản nháp của bạn ở cấp độ cấu trúc là kiểm tra cách bạn đã xác định các đoạn văn. Các đoạn văn là những sinh vật kỳ lạ—một số học giả về viết lách tin rằng chúng không tồn tại và chỉ là những điểm ngắt tùy ý mà các nhà văn ném vào bất cứ lúc nào và ở đâu mà họ thích. Xin lỗi—trong viết kỹ thuật, đoạn văn là một nhân tố quan trọng trong cuộc chiến vì sự rõ ràng và hiểu biết. Mặc dù không phải lúc nào cũng có thể, các đoạn văn nên xảy ra khi có sự thay đổi trong chủ đề hoặc tiểu chủ đề hoặc sự thay đổi trong cách một chủ đề đang được thảo luận.
Trên một trang viết đơn khoảng cách, hãy tìm ít nhất một đến bốn đoạn ngắt—không có gì kỳ diệu về con số trung bình đó, vì vậy đừng coi nó như một điều luật. Chỉ cần dành một chút thời gian xem lại những đoạn văn dài, và kiểm tra khả năng có thể ngắt đoạn.
Tôi sẽ rất trân trọng suy nghĩ, phản ứng, và những góp ý của bạn về chương này: phản hồi của bạn—David McMurrey.
