Technical writing is the art of com

Technical writing is the art of communicating technical knowledge to a specified audience. The topic may be as simple as a recipe or as complex as an integral equation. Some of the common technical documents are business letters and user manuals. The nature of the subject and audience determines the style and structure in which technical content is packaged. The text may contain definitions of technical terms, descriptions of products, instructions and examples. In most cases, text is accompanied by graphics/tables/illustrations. Some of the text structures are a) inverted pyramid b) topic-development-conclusion and c) situation-problem-solution-evaluation.

Technical writing requires an understanding of three principles: a) brevity b) clarity and c) scannability. Brevity is the avoidance of superfluous words, phrases and sentences. Clarity is the unambiguous and logical presentation of data or ideas. Scannability is the use of lists, visuals and tables based on the principles of brevity and clarity.

Technical writers have to choose words with care. The P-F-S rule describes a hierarchy of Precise, Familiar and Short words. The order of choice is P-F-S, P-F, P-S, P. There may be more than one precise form of expression. Technical writers have to first seek a word that is precise, familiar and short. If not available, then precise and familiar word is the next choice. This is because a familiar word is better than a short but difficult word. If even a P-F word is not available, then go for the P-S word. The final choice is the P word. We have ignored the F-S words because in technical writing precision is more important than familiarity and brevity.

Technical writers should also take care in constructing sentences and paragraphs. They need to know basic grammar and the different kinds of sentence styles. Some of the common grammatical mistakes are dangling modifiers, misplaced phrases, subject-verb disagreements and wrong tenses. Some of the stylistic errors are redundancies, weak be-verbs, unnecessary expletives and overnominalisation. These problems are dealt with by David A. McMurrey in his book on technical writing. The book deals with all aspects of technical writing and is available online at http://www.io.com/~hcexres/textbook/

A well-written technical text, based on the principles stated here, may now be checked for readability using the FORCAST formula. Patrick FORd, John CAYlor and Tom STicht developed this formula for measuring readability of technical materials. Sticht, who headed the team, published an article about the formula in 1973. Here is the formula: 20 – N/10. N is the number of monosyllabic words in a sample passage of 150 words. The greater the score, the greater the reading difficulty.

If the FORCAST score is high, the text has to be rewritten. The formula seems to suggest that monosyllabic words enhance reading ease. It may not be wise to write to a formula. Moreover, the formula is only indicative of reading difficulty. Nevertheless, it may be stated as a principle that monosyllabic words are better than polysyllabic words. But brevity may be sacrificed if precision is at stake.

The rewritten text must now be reviewed by peers and then the final version lands on the desk of technical editors.

Results (Vietnamese) 1:

Kỹ thuật văn bản là nghệ thuật giao tiếp kiến thức kỹ thuật cho một đối tượng cụ thể. Các chủ đề có thể được như đơn giản như là một công thức hoặc phức tạp như một phương trình tích phân. Một số tài liệu kỹ thuật phổ biến là kinh doanh thư và hướng dẫn sử dụng. Bản chất của chủ đề và đối tượng sẽ xác định các phong cách và cấu trúc trong đó nội dung kỹ thuật đóng gói. Văn bản có thể chứa các định nghĩa của thuật ngữ kỹ thuật, mô tả sản phẩm, hướng dẫn và ví dụ. Trong hầu hết trường hợp, văn bản được đi kèm với đồ họa/bảng/minh họa. Một số cấu trúc văn bản là kim tự tháp a) đảo ngược b) chủ đề-phát triển-kết luận và c) tình trạng vấn đề-giải pháp-đánh giá.Kỹ thuật văn bản đòi hỏi một sự hiểu biết về ba nguyên tắc: một) ngắn gọn b) rõ ràng và c) scannability. Ngắn gọn là tránh sự thừa từ, cụm từ và câu. Rõ ràng là trình bày rõ ràng và hợp lý của dữ liệu hoặc ý tưởng. Scannability là việc sử dụng các danh sách, hình ảnh và bảng dựa trên các nguyên tắc của ngắn gọn và rõ ràng.Nhà văn kỹ thuật phải chọn từ với việc chăm sóc. Quy tắc P-F-S mô tả một hệ thống phân cấp của Precise, quen thuộc và ngắn từ. Thứ tự của sự lựa chọn là P-F-S, P-F, P-S, P. Có thể có nhiều hơn một hình thức biểu hiện chính xác. Nhà văn kỹ thuật phải lần đầu tiên tìm kiếm một từ đó là chính xác, quen thuộc và ngắn. Nếu không có sẵn, sau đó chính xác và quen thuộc từ là sự lựa chọn tiếp theo. Điều này là do một từ quen thuộc là tốt hơn so với một từ ngắn nhưng khó khăn. Nếu ngay cả một từ P-F là không có sẵn, sau đó đi cho từ P-S. Sự lựa chọn cuối cùng là từ P. Chúng tôi đã bỏ qua các từ F-S, bởi vì trong chính xác bằng văn bản kỹ thuật là quan trọng hơn sự quen thuộc và ngắn gọn.Nhà văn kỹ thuật cũng nên chăm sóc trong xây dựng các câu và đoạn văn. Họ cần phải biết cơ bản ngữ pháp và các loại khác nhau của phong cách câu. Một số trong những sai lầm phổ biến về ngữ pháp tòn ten bổ, bị thất lạc cụm từ, động từ chủ đề bất đồng và sai thì. Một số lỗi phong cách là dư thừa, yếu-động từ, không cần thiết lời rủa và overnominalisation. Những vấn đề này được giải quyết bởi David A. McMurrey trong cuốn sách về kỹ thuật bằng văn bản. Cuốn sách đề với tất cả các khía cạnh kỹ thuật viết và có sẵn trực tuyến tại http://www.io.com/~hcexres/textbook/Một văn bản bài viết kỹ thuật, dựa trên các nguyên tắc nêu ở đây, bây giờ có thể được kiểm tra cho dễ đọc bằng cách sử dụng công thức baùo möùc ñoä. Patrick FORd, John CAYlor và Tom STicht phát triển công thức này để đo lường dễ đọc của vật liệu kỹ thuật. Sticht, người đứng đầu nhóm nghiên cứu, xuất bản một bài viết về công thức vào năm 1973. Đây là công thức: 20-N/10. N là một số trong các từ ngữ đơn âm trong một đoạn văn mẫu của 150 từ. Lớn hơn các điểm số, lớn hơn những khó khăn đọc.Nếu các điểm baùo möùc ñoä cao, các văn bản đã được viết lại. Công thức dường như cho thấy rằng đơn âm từ nâng cao một cách dễ dàng đọc. Nó có thể không được khôn ngoan để viết thư cho một công thức. Hơn nữa, công thức chỉ là chỉ đọc khó khăn. Tuy nhiên, nó có thể được nêu như là một nguyên tắc đơn âm từ là tốt hơn so với polysyllabic từ. Nhưng ngắn gọn có thể hy sinh nếu chính xác là lúc cổ phần.Các văn bản viết lại bây giờ phải được xem xét bởi đồng nghiệp và sau đó phiên bản cuối cùng đất trên bàn làm việc của biên tập viên kỹ thuật.

Results (Vietnamese) 2:

Văn bản kỹ thuật là nghệ thuật của truyền thông kiến thức kỹ thuật cho một đối tượng cụ thể. Các chủ đề có thể đơn giản như là một công thức, hay phức tạp như một phương trình tích phân. Một số tài liệu kỹ thuật phổ biến là thư tín thương mại và hướng dẫn sử dụng. Bản chất của chủ thể và đối tượng xác định phong cách và cấu trúc trong đó nội dung kỹ thuật được đóng gói. Các văn bản có thể chứa các định nghĩa của các thuật ngữ kỹ thuật, mô tả về sản phẩm, hướng dẫn và ví dụ. Trong hầu hết các trường hợp, văn bản đi kèm với đồ họa / bảng / hình minh họa. Một số trong những cấu trúc văn bản là a) ngược kim tự tháp b) đề-phát triển-kết luận và c) tình hình-vấn giải pháp đánh giá. Văn bản kỹ thuật đòi hỏi một sự hiểu biết về ba nguyên tắc: a) ngắn gọn b) rõ ràng và c) scannability. Ngắn gọn là tránh những lời thừa, cụm từ và câu. Clarity là trình bày rõ ràng và hợp lý của dữ liệu hoặc ý tưởng. Scannability là việc sử dụng danh sách, hình ảnh và các bảng dựa trên các nguyên tắc ngắn gọn và rõ ràng. Nhà văn kỹ thuật phải lựa chọn từ ngữ cẩn thận. Các quy tắc PFS mô tả một hệ thống phân cấp của các từ chính xác, quen thuộc và ngắn. Thứ tự của sự lựa chọn là PFS, PF, PS, P. Có thể có nhiều hơn một hình thức chính xác của biểu thức. Nhà văn kỹ thuật trước tiên phải tìm kiếm một từ đó là chính xác, quen thuộc và ngắn. Nếu không có sẵn, sau đó từ chính xác và quen thuộc là sự lựa chọn tiếp theo. Điều này là bởi vì một từ quen thuộc là tốt hơn so với một từ ngắn nhưng khó khăn. Nếu ngay cả một từ PF là không có sẵn, sau đó đi cho từ PS. Sự lựa chọn cuối cùng là chữ P. Chúng tôi đã bỏ qua những lời FS vì trong văn bản kỹ thuật chính xác là quan trọng hơn sự quen thuộc và ngắn gọn. Nhà văn kỹ thuật cũng cần chăm sóc trong việc xây dựng các câu và đoạn văn. Họ cần phải biết ngữ pháp cơ bản và các loại khác nhau của các kiểu câu. Một số trong những sai lầm ngữ pháp phổ biến là treo lủng lẳng bổ từ, cụm từ bị thất lạc, bất đồng-chủ động từ và các thì sai. Một số lỗi về phong cách là dư thừa, yếu be-động từ, lời tục tĩu không cần thiết và overnominalisation. Những vấn đề này được xử lý bởi David A. McMurrey trong cuốn sách về văn bản kỹ thuật. Các chương trình giảm giá sách với tất cả các khía cạnh của văn bản kỹ thuật và có sẵn trực tuyến tại http://www.io.com/~hcexres/textbook/ Một văn bản kỹ thuật được viết tốt, dựa trên các nguyên tắc đã nêu ở đây, nay có thể được kiểm tra để có thể đọc bằng cách sử dụng công thức DỰ BÁO. Patrick Ford, John CAYlor và Tom STicht phát triển công thức này để đo lường khả năng đọc tài liệu kỹ thuật. Sticht, người đứng đầu nhóm nghiên cứu, xuất bản một bài viết về công thức trong năm 1973. Đây là công thức: 20 - N / 10. N là số từ đơn âm trong một vài đoạn 150 từ. Việc lớn hơn số điểm, càng khó đọc. Nếu điểm DỰ BÁO là cao, các văn bản phải được viết lại. Công thức vẻ gợi ý rằng từ đơn âm tăng cường đọc dễ dàng. Nó có thể không được khôn ngoan để viết một công thức. Hơn nữa, công thức chỉ là biểu hiện của việc đọc khó khăn. Tuy nhiên, nó có thể được nêu như một nguyên tắc từ đơn âm là tốt hơn so với những từ đa âm tiết. Nhưng ngắn gọn có thể tiêu tan nếu chính xác là bị đe dọa. Các văn bản viết lại bây giờ phải được xem xét lại bởi đồng nghiệp và sau đó các vùng đất phiên bản cuối cùng trên bàn làm việc của biên tập viên kỹ thuật.