10 quy tắc cơ bản mà mọi người viết kỹ thuật phải tuân theo

Viết kỹ thuật truyền đạt thông tin kỹ thuật về một kỹ năng hoặc sản phẩm cho người đọc. Nó được sử dụng phổ biến trong các lĩnh vực kỹ thuật và nghề nghiệp. Là một người viết về kỹ thuật, bạn thường viết các tài liệu như hướng dẫn sử dụng, tài liệu về giao diện lập trình ứng dụng (API) và hướng dẫn sửa chữa và sản phẩm.

Giống như các ngách viết khác, viết kỹ thuật có các hướng dẫn dành riêng cho từng ngách. Làm theo các hướng dẫn này sẽ giúp bạn viết các tài liệu có cấu trúc tốt và tối ưu hóa cách người đọc hiểu tác phẩm của bạn. Dưới đây là một số quy tắc cần tuân theo để trở thành một người viết kỹ thuật giỏi.

1. Xác định đối tượng của bạn

Phân tích đối tượng là một yếu tố không thể thiếu trong một tài liệu kỹ thuật tốt. Biết đối tượng của mình giúp bạn xác định loại thông tin cần viết, cách bạn nên cấu trúc thông tin và tính kỹ thuật của ngôn ngữ của bạn. Có bốn đối tượng chính để viết kỹ thuật: giám đốc điều hành, chuyên gia, kỹ thuật viên và những người không chuyên.

Giám đốc điều hành là những cá nhân tài trợ cho sản phẩm và đưa ra các quyết định chính trị, hành chính và kinh tế chi phối nó. Kỹ thuật viên là những người xây dựng, vận hành và sửa chữa các sản phẩm này. Các chuyên gia thiết kế, thử nghiệm và biết mọi thứ về sản phẩm, trong khi những người không chuyên là người sử dụng cuối cùng của sản phẩm. Bạn phải xem xét đối tượng của mình để xác định giọng điệu và phong cách viết tốt nhất để tuyển dụng.

2. Xác định nhu cầu của khán giả

Ngoài việc biết và xác định đối tượng của bạn, điều quan trọng là bạn phải hiểu mục tiêu, sở thích và nhu cầu của họ. Hoàn thành phân tích đối tượng của bạn là chìa khóa trong việc chuẩn bị tài liệu, vì bạn ít có khả năng viết mà không gặp trục trặc và biết rõ nhu cầu của khán giả.

Để thực hiện phân tích đối tượng toàn diện, bạn phải xem xét nền tảng của đối tượng, kiến ​​thức hiện có về sản phẩm, kinh nghiệm, nhu cầu, sở thích, đặc điểm nhân khẩu học, văn hóa và sở thích giao tiếp cũng như mục tiêu. Thông tin này sẽ hỗ trợ bạn trong việc trình bày ý tưởng của mình một cách hiệu quả và hiệu quả nhất.

3. Biết Giới hạn Kiến thức của Đối tượng của Bạn

Là một kỹ thuật phân tích khán giả, bạn có thể sử dụng các cuộc khảo sát và bảng câu hỏi để biết giới hạn kiến ​​thức của khán giả. Bạn cũng có thể lấy các ý kiến ​​và khuôn mẫu phổ biến, kinh nghiệm cá nhân, động não và phản hồi của khán giả, từ bộ phận tiếp thị.

Nếu bạn sử dụng đúng cách các công cụ được liệt kê ở trên, bạn sẽ biết đối tượng mục tiêu của bạn hiểu được thông tin bạn định truyền tải đến mức nào. Thông tin này sẽ xác định rất nhiều cấu trúc, giới hạn và phạm vi tài liệu của bạn, giúp bạn có định hướng.

4. Giữ cho ngôn ngữ của bạn đơn giản

Viết kỹ thuật phải trình bày một chủ đề quá phức tạp. Nó thực hiện điều này bằng cách sử dụng hướng dẫn phong cách viết đơn giản. Bạn nên đảm bảo rằng người đọc bình thường có thể dễ dàng hiểu được bài viết của bạn.

Tuy nhiên, bạn phải lưu ý rằng hiểu khán giả của bạn cũng là chìa khóa cho phong cách ngôn ngữ bạn chọn. Ví dụ: biệt ngữ chuyên môn trong tài liệu về giao diện lập trình ứng dụng (API) có thể phù hợp với kỹ thuật viên nhưng không phù hợp với người dùng cuối. Do đó, bạn phải sử dụng ngôn ngữ dễ hiểu để giúp khán giả hiểu. Bạn cũng có thể muốn tìm hiểu cách sử dụng một công cụ như Microsoft Editor để kiểm tra công việc của mình và đảm bảo rằng bài viết diễn ra đúng hướng.

5. Sử dụng dàn ý

Dàn ý cung cấp cho độc giả của bạn ý tưởng về những gì mong đợi trong tài liệu. Một tài liệu không có dàn ý sẽ khiến người đọc choáng ngợp, vì nó buộc họ phải đọc toàn bộ văn bản khi họ chỉ quan tâm đến việc lĩnh hội những kiến ​​thức cụ thể.

Là một người viết về kỹ thuật, việc lập dàn ý cho tài liệu của bạn cũng giúp bạn có định hướng khi viết. Nó giúp bạn đi đúng hướng và đảm bảo rằng bạn không bỏ lỡ hoặc đánh giá thấp các điểm có liên quan. Ngoài ra, nó nâng cao cấu trúc tài liệu của bạn và phục vụ như phản hồi về những gì bạn định trình bày.

6. Sử dụng đồ họa khi cần thiết

Hầu hết sự chú ý của độc giả được thu hút một cách tự nhiên vào đồ họa so với văn bản. Trong các tài liệu kỹ thuật, đồ họa phù hợp có thể cải thiện sự hiểu biết của người đọc về văn bản bằng cách trình bày thông tin một cách rõ ràng và nhấn mạnh.

Tuy nhiên, là một người viết kỹ thuật, bạn nên lưu ý không sử dụng đồ họa để trang trí tài liệu. Bảng, đồ thị, biểu đồ, ảnh và hình minh họa là những đồ họa thường được sử dụng và chúng có thể nâng cao cấu trúc tổng thể của tài liệu và hấp dẫn người đọc. Điều đó có nghĩa là, nếu bạn là người mới sử dụng Google Tài liệu, đây là cách tạo và chỉnh sửa bảng trong Google Tài liệu.

7. Thu hút người đọc của bạn

Mặc dù bạn có thể đang cố gắng truyền đạt thông tin kỹ thuật cho độc giả của mình, nhưng điều quan trọng là bạn phải thu hút họ. Mọi tài liệu kỹ thuật đều lấy người đọc làm trung tâm và phải được viết theo sở thích của người đọc chứ không phải người viết. Sự tò mò về trí tuệ của người đọc phải được thỏa mãn để tài liệu của bạn trở nên hữu ích.

Bạn có thể tích cực thu hút người đọc bằng cách viết để diễn đạt, không gây ấn tượng và đi thẳng vào vấn đề. Tránh viết tắt và biệt ngữ, sử dụng nhiều khoảng trắng để cải thiện trình bày trực quan và sử dụng tiêu đề để hướng dẫn người đọc của bạn.

8. Không tham chiếu thông tin nhạy cảm về thời gian

Việc tránh tham chiếu đến những thông tin nhạy cảm về thời gian, đặc biệt là những thông tin trong khoảng thời gian có thể so sánh được, luôn luôn được ưu tiên. Sẽ an toàn và khôn ngoan hơn nếu sử dụng phân tích đã chịu đựng được thử thách của thời gian, điều này khiến nó luôn xanh và phù hợp với những người sẽ đọc tài liệu của bạn trong tương lai.

Bạn cũng phải lưu ý rằng việc đính kèm các năm cụ thể, chẳng hạn như “2019,” để nhấn mạnh quan điểm của bạn có thể làm giảm tính hữu ích của tài liệu của bạn theo thời gian, ngoại trừ một số trường hợp cụ thể. Bạn có thể ngăn chặn điều này bằng cách sử dụng khung thời gian rộng hơn như “Trong bảy năm qua”, do đó, tạo cho công việc của bạn một mức độ uy tín.

9. Sử dụng các ví dụ có liên quan

Khi viết một tài liệu kỹ thuật, hãy sử dụng các phiên bản trực tiếp để nhấn mạnh các điểm của bạn. Vì khán giả của bạn đọc bài viết của bạn để có được một kỹ năng, giải quyết một vấn đề hoặc tìm hiểu một số hướng dẫn, bạn phải cung cấp cho họ những ví dụ thực tế và có thể liên quan.

Những ví dụ này nâng cao khả năng đọc của công việc và truyền đạt thông tin phức tạp cho người đọc, cung cấp ngữ cảnh cho các sản phẩm và quy trình. Bằng cách này, họ có nhiều khả năng sử dụng các sản phẩm một cách có chủ đích và an toàn hơn.

10. Nhận đánh giá của bên thứ ba trước khi xuất bản

Một tài liệu kỹ thuật luôn phải trải qua một quá trình hợp tác có sự tham gia của người viết và người đánh giá. Đánh giá của bên thứ ba giúp tạo ra một tài liệu tập trung vào người xem, không có lỗi và có tác động.

Là tác giả ban đầu của tài liệu, bạn có thể đã viết nhiều bản nháp trước khi tạo tài liệu cuối cùng. Tuy nhiên, cho dù tài liệu của bạn xuất hiện tốt đến đâu, đừng phụ thuộc vào trí thông minh của bạn.

Trở thành một nhà văn kỹ thuật chuyên nghiệp ngay hôm nay

Hiểu các quy tắc thiết yếu hướng dẫn kỹ thuật viết sẽ giúp bạn thành thạo hơn và được săn đón nhiều hơn. Nhiều tổ chức biết tầm quan trọng của việc sản phẩm hoặc dịch vụ của họ được tiếp thị tốt đến người dùng cuối và giúp họ đạt được điều này là mục tiêu của bạn với tư cách là người viết kỹ thuật.