ศิลปะการขัดเกลาต้นฉบับ - วิธีเขียนเอกสารเชิงเทคนิคสำหรับนักพัฒนา

• การขัดเกลาต้นฉบับ: การคิดทบทวนหลายครั้งระหว่างเขียนเพื่อแก้ไขและปรับแต่งข้อความ หรือหมายถึงกระบวนการดังกล่าว

• เหตุผลที่การขัดเกลาต้นฉบับเป็นสิ่งจำเป็น

• เคล็ดลับการขัดเกลาต้นฉบับ

→ ทำให้บทความของตัวเองดูแปลกตา: อ่านออกเสียง, อ่านอีกครั้งหลังเวลาผ่านไปสักพัก, พิมพ์ออกกระดาษแล้วอ่าน

→ การรีวิวโดยเพื่อนร่วมงาน

→ ใช้เช็กลิสต์

→ เคล็ดลับการแก้ประโยคเพื่อให้อ่านง่ายขึ้น

① สรุปและแก้ไขให้เป็นประโยคสั้น

② ลบสำนวนที่ไม่จำเป็น

③ ปรับให้เป็นงานเขียนที่มีตรรกะมากขึ้น

[budlebee]

ทำให้นึกถึงหลักการเขียนของ Stephen King เลยครับ แม้จะเป็นงานนิยายจึงอาจมีจุดที่ต่างจาก technical writing อยู่บ้าง แต่ถ้าจะเขียนเท่าที่นึกออกก็ประมาณนี้

• ใช้ประโยคสั้นและเรียบง่าย

• ผมเขียนฉบับร่างแรกเสร็จแล้วจะเก็บมันไว้ในลิ้นชัก จากนั้นอีก 6 เดือนค่อยหยิบออกมาอ่านใหม่

• ฉบับแก้ไขจะตัดออกจากฉบับร่างแรก 10%

• ลองอ่านออกเสียงดู จะช่วยจับส่วนที่ประโยคฟังดูแปลก ๆ ได้

• เขียนโดยกำหนดผู้อ่านเป้าหมายให้ชัดเจน สำหรับผมคือภรรยาของผม

[xguru]

ช่วงนี้ทีม Technical Writing ของ Kakao Enterprise เขียนบทความดีๆ ออกมาเยอะมากเลยนะ แนะนำให้ติดตามบล็อกไว้!