Toss เปิดเผยคู่มือการเขียนเชิงเทคนิค
(technical-writing.dev)หลักการสำคัญของการเขียนเอกสารทางเทคนิคที่ดี
1. กำหนดประเภทของเอกสาร
วิธีเขียนให้มีประสิทธิภาพมากขึ้นจะแตกต่างกันไปตามวัตถุประสงค์ของเอกสาร
- เอกสารเพื่อการเรียนรู้: มีจุดประสงค์เพื่อทำความเข้าใจภาพรวมเมื่อได้พบกับเทคโนโลยีหรือเครื่องมือใหม่เป็นครั้งแรก
- เอกสารแก้ปัญหา: มีจุดประสงค์เพื่อแก้ปัญหาเฉพาะเมื่อมีความรู้พื้นฐานอยู่แล้ว
- เอกสารอ้างอิง: มีจุดประสงค์เพื่อตรวจสอบฟีเจอร์เฉพาะหรือวิธีใช้ API แม้จะรู้วิธีใช้งานอยู่แล้ว
- เอกสารอธิบาย: มีจุดประสงค์เพื่อทำความเข้าใจแนวคิด หลักการ และความรู้พื้นฐานอย่างละเอียด
2. สร้างโครงสร้างข้อมูล
การทำความเข้าใจความรู้ใหม่ต้องอาศัยความพยายาม แต่หากจัดโครงสร้างข้อมูลให้ดี ก็จะช่วยลดความพยายามลงได้
- พูดถึงเพียงเรื่องเดียวในหนึ่งหน้า
- มอบคุณค่าก่อน
- เขียนหัวข้อให้มีประสิทธิภาพ
- อย่าละเลยภาพรวม
- ทำให้คาดเดาได้
3. ปรับแต่งประโยค
หากเพิ่มพลังในการสื่อสารของประโยค ผู้อ่านจะเข้าใจเนื้อหาได้ง่ายขึ้น หากรายละเอียดถูกเขียนด้วยประโยคที่เข้าใจยาก พลังในการสื่อสารก็จะลดลงอย่างมาก
- ทำให้ประธานของประโยคชัดเจน
- เหลือไว้เฉพาะข้อมูลที่จำเป็น
- เขียนให้เป็นรูปธรรม
- ใช้สำนวนภาษาเกาหลีที่เป็นธรรมชาติ
- เขียนอย่างสม่ำเสมอ
6 ความคิดเห็น
มีที่ไหนรวบรวมเว็บไซต์แบบนี้ที่ Toss ทำไว้บ้างไหม?
สำนวนลงท้ายแบบ "yo" ปรับตัวให้ชินยากนะครับ/ค่ะ
พูดได้ถูกต้องเลยครับ
ดีเลยครับ โดยเฉพาะเนื้อหาเรื่องการขัดเกลาประโยค น่าจะต้องลองทำเป็น few-shot ด้วย GPTs แล้วเอามาใช้ดูครับ
ผมคิดว่าบทความแบบนี้ดีครับ ในยุคของ LLM แนวทางลักษณะนี้จะถูกปรับเปลี่ยนไปอย่างไรได้บ้างนะ?
เป็นโปรเจกต์ที่ดีมากเลย ^^