2 điểm bởi GN⁺ 2024-04-07 | 1 bình luận | Chia sẻ qua WhatsApp

Những điều cần nghĩ đến khi biên tập bài viết

  • Truyền đạt bài viết một cách chính xác

    • Trước khi viết, cần xác định mình muốn nói điều gì.
    • Cần làm rõ mục đích của bài viết bằng cách cân nhắc chủ đề, đối tượng độc giả, v.v., và ghi điều đó ở phần đầu tài liệu.
    • Trong quá trình viết và biên tập, đối chiếu với mục đích này để giữ tính nhất quán.
  • Lặp lại trong phạm vi hợp lý

    • Để độc giả có thể hiểu chủ đề, hãy xác nhận lại chủ đề ở phần mở đầu và phần kết.
    • Để tăng độ rõ ràng, việc lặp lại bằng danh từ thay vì động từ có thể hữu ích.
  • Đơn giản hóa

    • Loại bỏ từ ngữ không cần thiết và làm cho câu văn ngắn gọn.
    • Thay các cách diễn đạt như "bạn" hoặc "bạn có thể" bằng câu mệnh lệnh ngắn gọn.
    • Chia câu dài thành câu ngắn hơn, và dùng dấu phẩy hợp lý để giúp độc giả dễ hiểu hơn.
  • Loại bỏ thể bị động

    • Thể bị động khiến chủ thể hành động trở nên mơ hồ, làm câu văn kém rõ ràng hơn.
    • Chuyển sang thể chủ động sẽ giúp câu rõ ràng và dễ hiểu hơn.
  • Đừng dùng trạng từ

    • Thay vì dùng trạng từ, hãy dùng động từ cụ thể hơn hoặc thêm phần giải thích để diễn đạt.
    • Trạng từ thường không truyền đạt chính xác ý nghĩa cho độc giả và để lại sự mơ hồ.
  • Đừng giả định kiến thức có sẵn

    • Hãy cung cấp phần nền tảng phù hợp cho những thông tin mà độc giả có thể chưa biết.
    • Khi dùng chữ viết tắt lần đầu, hãy viết đầy đủ và thêm giải thích.
  • Nhận thức về giọng điệu

    • Giọng điệu của bài viết phải nhất quán, không trộn lẫn giọng thân thiện với giọng trang trọng.
  • Tránh biệt ngữ chuyên môn và sáo ngữ

    • Hãy dùng cách diễn đạt chính xác để độc giả dễ hiểu.
    • Biệt ngữ chuyên môn có thể khó hiểu nếu độc giả không thuộc một nhóm cụ thể.
  • Tận dụng khoảng trắng

    • Chia nhỏ các đoạn văn dài, và dùng tiêu đề phụ, danh sách, bảng, v.v. để tăng khả năng đọc.
    • Nhấn mạnh nội dung quan trọng bằng chữ đậm để độc giả không bỏ lỡ các điểm chính.

Kết luận

  • Nguyên tắc cơ bản của việc biên tập là truyền đạt ý nghĩa rõ ràng và loại bỏ từ ngữ không cần thiết.
  • Khi tuân theo các nguyên tắc này, bạn vẫn có thể phát triển phong cách và sở thích riêng của mình.
  • Mục đích của việc biên tập là suy nghĩ về cách dùng ngôn ngữ và đưa ra lựa chọn phù hợp để truyền tải thông điệp.

Ý kiến của GN⁺

  • Việc giữ vững mục đích và tính nhất quán của bài viết trong quá trình biên tập là nguyên tắc quan trọng đối với mọi hình thức viết.
  • Việc dùng thể bị động là một phong cách nên đặc biệt tránh trong tài liệu kỹ thuật, và chuyển sang thể chủ động góp phần nâng cao độ rõ ràng.
  • Tránh dùng trạng từ và sử dụng cách diễn đạt cụ thể là điều hiệu quả không chỉ trong tài liệu kỹ thuật mà còn trong mọi loại hình viết.
  • Phần giải thích nền tảng cho những thông tin mà độc giả có thể chưa biết đặc biệt quan trọng trong tài liệu kỹ thuật, vì nó giúp tăng mức độ hiểu và cải thiện khả năng tiếp cận của tài liệu.
  • Việc sử dụng khoảng trắng và phân tách trực quan là yếu tố quan trọng giúp cải thiện khả năng đọc của nội dung trực tuyến.

1 bình luận

 
GN⁺ 2024-04-07
Ý kiến Hacker News
  • Tóm tắt bình luận thứ nhất:

    • Tác giả cho biết mình thấy vinh dự khi bài viết nhận được sự đồng cảm từ nhiều người.
    • Đã trở thành kỹ sư phần mềm vì đi theo sự tò mò, và sau vài năm làm việc thì nhớ những vai trò thiên về viết lách.
    • Đang tìm một vai trò kết hợp kỹ năng kỹ thuật với khả năng giao tiếp, và có thể liên hệ qua website và LinkedIn.
  • Tóm tắt bình luận thứ hai:

    • Việc dùng chữ viết tắt trong tài liệu kỹ thuật mà không giới thiệu trước gây khó chịu.
    • Trong tài liệu dự án được lặp đi lặp lại, khi thành viên thay đổi thì có thể không còn ai biết ý nghĩa của các chữ viết tắt đó.
    • Đôi khi giải pháp duy nhất là coi chữ viết tắt như danh từ riêng và tiếp tục dùng chúng.
  • Tóm tắt bình luận thứ ba:

    • Với tư cách là người rà soát tài liệu kỹ thuật, người viết đã sử dụng nhiều bộ hướng dẫn.
    • Đề xuất bổ sung rằng không nên gọi cùng một thứ bằng những tên khác nhau.
    • Khi có nhiều tác giả, cách dùng thuật ngữ có thể khác nhau và gây nhầm lẫn cho độc giả.
  • Tóm tắt bình luận thứ tư:

    • Không đồng ý với lời khuyên "tránh thể bị động".
    • Thể bị động là một công cụ có thể thay đổi góc nhìn về hành động.
    • Khi dùng thể bị động, người viết có thể chọn có nhắc đến nguồn gốc của hành động hay không.
  • Tóm tắt bình luận thứ năm:

    • Việc quyết định viết cho ai là điều khó khăn.
    • Cần cân nhắc nhiều nhóm độc giả như độc giả kỹ thuật, độc giả phổ thông và độc giả không chuyên về kỹ thuật.
    • Có sự giằng co giữa việc cố làm cho bài viết dễ tiếp cận hơn với nhiều người và việc muốn rút ngắn độ dài.
  • Tóm tắt bình luận thứ sáu:

    • Bày tỏ sự nhiệt huyết đối với việc cải thiện kỹ năng viết.
    • Đưa ra lời khuyên về tầm quan trọng của việc dùng danh sách và cách sử dụng chúng cho phù hợp.
  • Tóm tắt bình luận thứ bảy:

    • Đề xuất tránh dùng từ "just".
    • "just" gợi ý rằng điều gì đó là đơn giản, nhưng thực tế có thể không phải vậy.
  • Tóm tắt bình luận thứ tám:

    • Nhấn mạnh tầm quan trọng của khoảng trắng không chỉ trong tài liệu kỹ thuật mà còn trong blog, email và các nội dung khác.
    • Các đoạn văn dài rất khó đọc và mọi người dễ mất tập trung.
  • Tóm tắt bình luận thứ chín:

    • Từng làm việc tại một MSP trong quá khứ và nhận ra tầm quan trọng của các hướng dẫn vận hành được viết tốt.
    • Muốn tìm các nguyên tắc có thể giúp ích cho việc viết tài liệu, dựa trên kinh nghiệm có được từ báo chí.
  • Tóm tắt bình luận thứ mười:

    • Đề xuất tránh dùng thì tương lai.
    • Trong tài liệu, diễn đạt kiểu "làm như vậy sẽ..." kém hơn so với cách viết "làm như vậy là...".