Technical writing là gì

Viết kỹ thuật so với Viết chung

Mọi người đều không có sự tinh tế để viết vì không phải ai cũng là một nhà hùng biện giỏi. Tuy nhiên, có nhiều cách để cải thiện cách viết của một người để làm cho nó hấp dẫn hơn, không có lỗi và rõ ràng để đạt được suy nghĩ của các nhà văn. Từ ngữ hùng mạnh hơn một thanh kiếm theo nghĩa là chúng truyền cảm hứng, giáo dục và giải trí cho mọi người. Nhưng không phải tất cả các văn bản là bằng hoặc giống nhau. Viết chung, chẳng hạn như viết suy nghĩ và ý kiến ​​của bạn về một vấn đề xã hội, hoàn toàn khác với phong cách viết khác được gọi là viết kỹ thuật. Không nên nhầm lẫn giữa hai phong cách, viết kỹ thuật và viết chung, vì chúng phục vụ các mục đích rất khác nhau và cũng có nghĩa là cho các đối tượng khác nhau rất lớn.

Viết chung

Trong khi viết về các chủ đề chung, nhà văn phải đặt mình vào vị trí của một người đọc để thấy được hiệu quả của việc viết của chính mình. Viết một đoạn văn xuôi yếu không quá nghiêm trọng khi so sánh với một đoạn đầy lỗi. Đây là khi độc giả bị lẫn lộn và mất tập trung. Mọi người tôn trọng văn bản chất lượng cao và có xu hướng coi trọng người viết khi tác phẩm không có lỗi và thông báo xuất hiện rõ ràng.

Chính tả và ngữ pháp có ý nghĩa rất lớn đối với người đọc. Anh ta phát cáu khi nhìn thấy những sai lầm như vậy vì anh ta mong đợi không có gì hoàn hảo hơn từ một tờ giấy in. Đây là nơi kiểm tra chính tả và chỉnh sửa sau khi bạn viết xong trở nên tiện dụng. Sau đây tất nhiên là nội dung, nó phải hợp lý và tuần tự để không có lý do cho sự mơ hồ và tối nghĩa trong tâm trí của độc giả. Một thành phần quan trọng khác là cuộc sống. Nội dung phải sinh động để giữ cho người đọc quan tâm.

Văn bản kỹ thuật

Viết kỹ thuật là một hình thức viết được nhìn thấy nhiều hơn bất kỳ loại văn bản nào khác với những người thậm chí không nhận ra thực tế. Bản chất của tất cả các văn bản kỹ thuật là CÁCH. Ở mức độ đơn giản, bạn có thể lấy các ví dụ về một cuốn sách nấu ăn đầy đủ các công thức nấu ăn hoặc hướng dẫn sử dụng về cách vận hành điện thoại di động như viết kỹ thuật. Một phần tốt của văn bản kỹ thuật không có nghĩa là cho công chúng nói chung. Điều này bao gồm văn bản kinh doanh để giao tiếp với quản lý, nhân viên và các doanh nghiệp khác và có đầy đủ các thuật ngữ liên quan đến thế giới kinh doanh.

Theo nghĩa rộng hơn, sách giáo khoa của các môn khoa học cũng là ví dụ về văn bản kỹ thuật. Nếu bạn là sinh viên nhiếp ảnh, bất kỳ cuốn sách nào chứa thông tin có giá trị đối với bạn đều là một hình thức viết kỹ thuật vì nó chứa những từ mà công chúng có thể không hiểu hoặc đánh giá cao.

Cho dù dành cho đối tượng chung hoặc cho độc giả cụ thể, văn bản kỹ thuật nên rõ ràng và súc tích. Nó sẽ hữu ích cho các độc giả mà nó được dự định. Mặc dù viết kỹ thuật chắc chắn khác với viết một câu chuyện hoặc một bài thơ, bất kỳ văn bản kỹ thuật nào cũng phải có nội dung được trình bày theo cách mà nó có khả năng thu hút người đọc. Tài liệu nên được sắp xếp theo cách mà người đọc có được thông tin mà anh ta đang tìm kiếm và cũng dễ dàng hiểu được vấn đề.

Tóm lại:

Viết chung vs Viết kỹ thuật

• Viết chung và viết kỹ thuật là hai phong cách viết khác nhau

• Mặc dù các điều cơ bản vẫn giống nhau [cả hai đều cần thu hút người đọc và không có lỗi chính tả và lỗi ngữ pháp], viết kỹ thuật được coi là khó hơn một chút so với viết chung vì nó cần cung cấp thông tin một cách rõ ràng rằng người đọc có thể đồng hóa và hiểu.

• Viết chung nói nhiều hơn về việc khơi dậy sự quan tâm của người đọc trong khi viết kỹ thuật có mục tiêu duy nhất là làm cho người đọc hiểu một chủ đề một cách thú vị.

• Viết kỹ thuật có hướng dẫn chung để tuân theo và nó phải rõ ràng và súc tích. Nó phải ở ngôi thứ nhất và tránh giọng nói thụ động.

Tác giả: Edidiong Asikpo

Tiếp tục chuỗi bài chia sẻ thêm về những cách thức để có thể trở thành một Technical Writer chuyên nghiệp và tài năng hơn.

Nên bắt đầu từ đâu cho quá trình trở thành một Technical Writer?

“Bí mật của sự dẫn đầu là bắt đầu ngay từ bây giờ” – đây là một câu nói nổi tiếng của Mark Twain. Hãy bắt đầu ngay từ bây giờ để có thể trở thành một Technical Writer chất lượng và chuyên nghiệp nhất.

Tham gia một số khóa học chuyên đào tạo kỹ thuật viết chuyên nghiệp

Technical writing là một vấn đề khó, yêu cầu người viết không chỉ cung cấp kiến thức mà còn cần diễn đạt nó một cách đơn giản và dễ hiểu nhất. Tham gia một khóa học chuyên nghiệp về kỹ thuật đôi khi có thể khiến bạn cảm thấy không cần, nhưng nó thật sự sẽ giúp bạn khám phá ra nhiều vấn đề hay ho và có những quyết định đúng đắn khi xây dựng thương hiệu blog của riêng mình.

Thường xuyên đọc sách và tin tức về công nghệ

Đọc sách là điều cần thiết vì nó sẽ giúp bạn làm giàu vốn từ vựng của mình, bắt kịp các xu hướng hiện tại, khám phá những gì đang diễn ra trong thế giới viết lách, và cũng giúp giữ cho tinh thần viết lách luôn sống động.

Đối với vấn đề này, bạn có thể tìm hiểu thêm các bài viết về công nghệ thông tin, xu hướng công nghệ cũng như kiến thức lập trình từ các trang web uy tín như trên freeCodeCamp, Hashnode, The Writing HTX và một số trang khác.

  Con đường để bạn trở thành tech lead

  CTO là gì - Những sự thật cần biết về Chief Technology Officer 

Bắt tay vào viết bài

Ngay cả khi bạn tham gia tất cả các khóa học viết về các vấn đề mang tính kỹ thuật và đọc tất cả các bài báo công nghệ bạn có thể tìm thấy, điều đó đương nhiên sẽ không khiến bạn trở thành một nhà văn hay một người sáng tạo bài viết chuyên nghiệp. Bạn cần thực sự viết để trở thành một nhà văn.

Bạn có thể tự hỏi làm thế nào để bạn thực sự bắt tay vào viết bài?

Đầu tiên, bạn cần nghĩ ra chủ đề mà bạn muốn viết. Sau đó, bạn nên thực hiện các nghiên cứu cần thiết, viết bản thảo của bài báo và đọc lại bài báo [nhiều hơn một lần]. Khi bạn đã sẵn sàng, cuối cùng bạn có thể xuất bản bài viết trên blog của mình.

Bạn không cần phải xây dựng blog của mình từ đầu bởi vì nó tốn rất nhiều thời gian và sẽ khiến bạn mất tập trung thực sự, đó là viết. Sau khi bạn đã cảm thấy thoải mái với việc viết lách, bạn có thể đăng ký trở thành tác giả khách mời trên freeCodeCamp. Nếu được chấp thuận, bạn có thể đăng các bài viết của mình lên nền tảng này và thu hút được nhiều đối tượng độc giả hơn.

Duy trì việc viết và sáng tạo nội dung mới một cách đều đặn

Viết liên tục đóng một vai trò rất lớn trong việc giúp bạn trở thành một blogger giỏi hơn. Nó giúp tăng cao năng suất của bạn, thay đổi quan điểm và xây dựng sự tự tin của bạn.

Cũng giống như mọi kỹ năng khác, bạn sẽ viết tốt hơn khi bạn có thể viết một cách liên tục. Hãy đặt mục tiêu viết ít nhất một bài báo mỗi tháng, và bạn thật sự nhận ra sự thay đổi về cách kỹ năng viết của mình cải thiện nếu bạn tiếp tục thực hiện nó một cách nhất quán.

Nếu bạn cần một số trách nhiệm giải trình với sự nhất quán của mình với tư cách là một nhà văn kỹ thuật, bạn có thể thử tham gia cuộc thi #2Articles1Week Writing Challenge để đánh giá kỹ năng của mình.

Đóng góp cho các dự án Open Source

Tài liệu cho các dự án open source được cho là quan trọng như chính phần mềm. Vì vậy, nếu bạn mong muốn trở thành một technical writer chuyên nghiệp, bạn có thể đóng góp những gì mình biết cho một dự án bởi vì con người không thể sử dụng những gì họ không hiểu.

Nếu bạn đang làm việc trong một dự án hoặc cho một tổ chức open source miễn phí. Nhưng các đóng góp open source có thể giúp bạn cải thiện kỹ năng viết, mở rộng mạng lưới và giúp bạn nhận được các đề xuất và giới thiệu từ những người theo dõi mình. Nó cũng có thể giúp bạn tăng cơ hội được chấp nhận tham gia vào Google Season of Docs.

Xem thêm Lead Engineer trông như thế nào?

Google Season of Docs là gì và nó có tầm quan trọng như thế nào?

Google Season of Docs là chương trình thường niên do Google tổ chức. Mục tiêu của nó là tập hợp các technical writers và các tổ chức open sources lại với nhau để thúc đẩy sự hợp tác và cải thiện số lượng tài liệu trong nguồn dữ liệu open sources.

Sáng kiến ​​này được xem là cực kỳ quan trọng vì tài liệu của một dự án open source cung cấp lộ trình để người dùng không chỉ hiểu thêm về dự án mà còn đóng góp những gì mình biết cho nó.

Trong suốt chương trình, các technical writers được chấp nhận dành từ 3 – 5 tháng để xây dựng một bộ tài liệu mới, cải thiện cấu trúc của các tài liệu hiện có, phát triển các hướng dẫn cần thiết hoặc cải thiện các quy trình đóng góp và hướng dẫn của một tổ chức open sources.

Điểm thú vị của chương trình này là bạn có thể được trả từ 3000 – 15.000 USD để đóng góp cho các dự án open source với tư cách là một technical writer. Bạn cũng sẽ có nhiều cơ hội hơn khi tham gia vào Technical Writing Team và có thể được tổ chức open sources giữ lại để tiếp tục làm việc với tư cách là một technical writer sau khi chương trình kết thúc.

Những tips hay ho để bắt đầu quá trình trở thành Technical Writing

  • Làm theo hướng dẫn và xây dựng văn phong viết ổn định. Nó sẽ giúp bạn đi đúng hướng và tuân theo các nguyên tắc viết bài kỹ thuật, công nghệ một cách tốt nhất.
  • Làm cho các đoạn văn trong bài trở nên ngắn gọn hơn để chúng hỗ trợ các ý tưởng phát triển một cách gọn gàng và rõ ràng nhất. Đừng nhồi nhét mọi thứ vào một đoạn văn.
  • Viết những câu ngắn gọn, rõ ràng và chính xác bởi vì sự đơn giản luôn giúp cho mọi thứ trở nên dễ dàng hơn.
  • Sau khi viết bản nháp đầu tiên, hãy đọc to nội dung của bạn trong khi giả sử chính bản thân là người đọc. Điều này sẽ giúp bạn phát hiện ra những thứ có thể được diễn đạt lại theo một cách dễ hiểu hơn.
  • Chỉnh sửa bản nháp đầu tiên của bạn khi tập trung nhất.
  • Tìm kiếm phản hồi bằng cách tham khảo ý kiến ​​của các chuyên gia trong lĩnh vực đang viết vì không có ai có thể nắm được tất cả các vấn đề liên quan đến technical.

Phỏng dịch theo bài viết gốc tại freecodecamp.org

Có thể bạn quan tâm:

Video liên quan

Chủ Đề