Google Technical Writing Course

• Words
  • Noun
  • Acronyms
  • Pronoun
• Active Voice
• Clear Sentence
• Short Sentence
• Lists and tables
• Paragraphs
• Audience
• Documents
• Punctuation
  • Comma
  • Semicolon
  • Em-Dashes
  • Parentheses

Words

Noun

1. ระวังการมีอยู่ของคำหรือศัพท์ที่ target audience จะไม่คุ้นเคย ในกรณีที่มีการใช้คำหรือศัพท์เหล่านั้น จะมีทางเลือกที่เป็นไปได้ 2 ทางได้แก่
   • ถ้าคำหรือศัพท์ดังกล่าวมีคำอธิบายหรือการให้ความหมายที่เหมาะสมแล้ว ให้เชื่อมโยงคำหรือศัพท์ไปยังความหมายที่มีอยู่
   • ถ้าคำหรือศัพท์ดังกล่าวถูกนำเสนอในเอกสารเป็นครั้งแรก ให้อธิบายหรือให้ความหมายคำหรือศัพท์เหล่านั้น ในกรณีที่คำหรือศัพท์ดังกล่าวมีเป็นจำนวนมาก การอธิบายหรือให้ความหมายจะต้องถูกรวบรวมอยู่ในหัวข้ออภิธานศัพท์ (glossary) แทน
2. พยายามใช้คำอย่างคงเส้นคงวา อย่าพูดถึงคำที่เรายังไม่ได้มีการแนะนำแก่ผู้อ่านแม้ว่าจะสามารถทำความเข้าใจถึงความเชื่อมโยงได้ ในกรณีที่เราสามารถอธิบายความเชื่อมโยงระหว่างคำได้ ให้กำหนด อธิบายและนำเสนอให้ผู้อ่านก่อนทันทีก่อนจะนำไปใช้ในส่วนอื่นของเอกสาร ตัวอย่างเช่น แม้จะเป็นที่เข้าใจกันว่า Protocol Buffers สามารถถูกย่อได้เป็น protobufs เราก็จำเป็นที่จะต้องแสดงให้เห็นถึงความเชื่อมโยงระหว่างสองคำนี้ก่อน เช่นเดียวกับการใช้ acronym หรือตัวย่อด้วย

Wrong: Protocol Buffers provide their own definition language. Blah, blah, blah. And that’s why protobufs have won so many county fairs.

Correct: Protocol Buffers (or protobufs for short) provide their own definition language. Blah, blah, blah. And that’s why protobufs have won so many county fairs.

Acronyms

ข้อควรระวังเพิ่มเติมในการใช้ acronym หรือตัวย่อคือ

• ไม่ควรบัญญัติตัวย่อเพิ่มขึ้นมาหากจะมีการใช้งานเพียงไม่กี่ครั้ง เนื่องจากผู้อ่านจำเป็นต้องขยายตัวย่อนั้นด้วยตัวเอง การขยายโดยไม่มีความจำเป็นจะเป็นการสร้างภาระในการทำความเข้าใจ
• หากจะมีการใช้ตัวย่อ ต้องแน่ใจว่าตัวย่อนั้นสั้นอย่างมีนัยยะสำคัญกว่าคำเต็ม และจะถูกใช้ในส่วนตัวไปของเอกสารอีกหลายครั้ง

Pronoun

เช่นเดียวกับการใช้ acronym หรือตัวย่อ คำสรรพนามเป็นคำซึ่งชี้กลับไปยังคำนามที่ได้มีการนำเสนอไปก่อนหน้า ดังนั้นเงื่อนไขและสิ่งที่ควรจะเป็นเมื่อมีการใช้คำสรรพนามจึงมีลักษณะคล้ายกับเงื่อนไขของการใช้ตัวย่อ ดังนี้

• คำสรรพนามจะใช้ได้ก็ต่อเมื่อเราได้มีการยกหรือพูดถึงคำนามมาแล้วก่อนหน้า อย่าใช้สรรพนามลอยๆ โดยที่ยังไม่ยกหรือพูดถึงคำนามโดยเด็ดขาด
• แนะนำให้มีการใช้คำสรรพนามให้ใกล้ต่อคำนามมากที่สุดเพื่อหลีกเลี่ยงปัญหาในการเชื่อมโยง โดยทั่วไปในภาษาอังกฤษ หากมีการใช้คำระหว่างคำนามและคำสรรพนามเกิน 5 คำ ควรพิจารณาในการใช้คำนามอีกครั้งแทนการใช้คำสรรพนามเพื่ออ้างถึง
• ในกรณีที่มีการยกคำนามคำที่สองขึ้นมาระหว่างการใช้คำนามแรกและการใช้คำสรรพนามเพื่ออ้างถึงคำนามแรก ควรมีการใช้คำนามแรกอีกครั้งและหลีกเลี่ยงการใช้คำสรรพนามในการอ้างอิงคำนามแรกเพื่อป้องกันความสับสน

Active Voice

Google แนะนำให้การเขียนเอกสารนั้นมีการใช้ active voice เป็นหลักแทนการใช้ passive voice โดยมีการให้เหตุผล อาทิ

• บางครั้ง passive voice ไม่สมบูรณ์ในใจความว่าใครเป็นผู้ทำอะไรต่อสิ่งใด
• ผู้อ่านจะทำความเข้าใจรูปประโยคแบบ passive voice โดยการเปลี่ยนเป็น active voice โดยที่ไม่รู้ตัว ดังนั้นการใช้ active voice เป็นหลักจะช่วยลดกระบวนการจัดรูปแบบและช่วยให้ผู้อ่านเข้าถึงใจความได้เร็วขึ้นกว่า
• ประโยคที่ใช้ active voice จะสั้นและสื่อสารได้ตรงประเด็นมากกว่าประโยคแบบ passive voice

Clear Sentence

1. ลดการใช้ verb ทั่วไปที่ไม่แสดงให้เห็นชัดเจนถึงการกระทำ โดยเฉพาะ verb รูปแบบของ be หรือคำว่า occur และ happen โดยเปลี่ยนการใช้ verb เหล่านี้ไปเป็นการใช้ verb ซึ่งแสดงให้เห็นถึงการกระทำที่ชัดเจนกว่าแทน อาทิ
   • จาก The error occurs when clicking the Submit button. เปลี่ยนเป็น Clicking the Submit button triggers the error.
   • จาก We are very careful to ensure… เปลี่ยนเป็น We carefully ensure…
2. ในกรณีของคำนาม การใช้ there is หรือ there are มีลักษณะของปัญหาใกล้เคียงกับกรณีของ verb ทั่วไป แนะนำให้ทำการเปลี่ยนการใช้คำเหล่านี้เป็นการอ้างถึงคำนามที่เฉพาะเจาะจงกว่าแทน
3. คน technical มักมี bias กับความเกินจริงของ marketing material ซึ่งความ marketing เหล่านั้นถูกนำเสนอผ่านการใช้คำขยายที่เกินจริง และไม่สอดคล้องต่อการทำความเข้าใจคำขยายเหล่านี้ในมุมมองส่วนบุคลล ดังนั้นในกรณีของเอกสารเชิงเทคนิค ผู้เขียนควรหลีกเลี่ยงการใช้ adjective หรือ adverb โดยควรเลือกที่จะนำเสนอข้อมูลหรือข้อเท็จจริงไปเลยแทน เช่น

Marketing: Setting this flag makes the application run screamingly fast.

Technical: Setting this flag makes the application run 225-250% faster.

Short Sentence

1. หนึ่งประโยคควรอธิบายแนวคิดหรือเหตุการณ์เพียงหนึ่งเหตุการณ์ ให้พิจารณาแยกแนวคิดหรือเหตุการณ์ออกเป็นประโยคที่ขาดจากกันและยกขึ้นมาเชื่อมกันเฉพาะเมื่อมีความจำเป็นเท่านั้น
2. ในกรณีที่ประโยคมีความยาวและมีการใช้คำสันธานหรือ conjunction ในการเชื่อม พิจารณาการแตกเนื้อหาดังกล่าวออกเป็นรายการทั้งที่มีลำดับหรือไม่มีลำดับเพื่อให้สามารถทำความเข้าใจได้ง่ายยิ่งขึ้น
3. หมั่นฝึกมองหาการใช้คำขยะที่เพิ่มความยาวของประโยคโดยไม่จำเป็น และแทนที่คำเหล่านั้นด้วยคำกริยาทั่วไปตรงๆ แทนเพื่อให้เข้าใจง่ายขึ้น อาทิ
   • จาก at this point in time เป็น now
   • จาก determine the location of เป็น find
   • จาก is able to เป็น can
4. หลีกเลี่ยงการใช้ประโยคเสริมหรืออนุประโยคเพื่อขยายความประโยคหลักหากประโยคเสริมนั้นนำเสนอประเด็นที่แตกต่างกันออกไป สังเกตได้จากการใช้ which, that, because, whose, until, unless และ since พิจารณาแยกเป็นประโยคใหม่หากประโยคย่อยไม่สอดคล้องกับประโยคหลัก
5. ใน American English การใช้ which นั้นเป็นการใช้สำหรับการเชื่อมโยงไปยังประโยคเสริมที่ไม่มีความสำคัญ และใช้ that สำหรับการเชื่อมโยงไปยังประโยคเสริมที่มีความสำคัญตามตัวอย่างด้านล่าง หรือสามารถสังเกตได้จากถ้าผู้อ่านหยุดก่อนอ่านประโยคเสริมให้ใช้ which แต่ถ้าอ่านประโยคเสริมต่อจากประโยคหลักให้ใช้ that
6. ใส่ comma เฉพาะก่อนหน้า which ไม่ต้องใส่ในกรณีที่ใช้ that

Lists and tables

• ใช้ bulleted list สำหรับรายการที่ไม่มีลำดับ การสลับเปลี่ยนรายการไม่มีผลต่อความหมาย และใช้ numbered list สำหรับรายการที่มีลำดับ เมื่อการสลับเปลี่ยนรายการมีผลต่อใจความหรือความหมาย
• ลำดับในรายการจะต้องแสดงให้เห็นการสอดคล้องกัน เช่น หากเป็นลำดับของการกระทำ แต่ละรายการต้องแสดงให้เห็นถึงการกระทำ ไม่ใช่ผลลัพธ์ที่เกิดจากการกระทำ
• พิจารณาขึ้นต้น numbered list ด้วย imperative verb หรือคำกริยาที่สั่งให้ทำเสมอ
• ถ้าเนื้อหาในรายการเป็นประโยค การ capitalization และ punctuation ก็ควรต้องเป็นแบบประโยค คือขึ้นต้นด้วยตัวใหญ่และลงท้ายด้วยจุด เช่นเดียวกันในกรณีที่ไม่ใช่ประโยค และของ capitalization และ punctuation แบบประโยคก็ไม่จำเป็นต้องใช้
• คุณลักษณะของตารางที่ดีคือ หัวคอลัมน์ชัดเจน ในตารางไม่มีตัวอักษรเยอะจนเกินไป (ไม่ควรเกิน 2 ประโยค) และคงความเป็น parallelism เอาไว้ในลักษณะที่คอลัมน์นั้นควรแสดงข้อมูลที่มีลักษณะสอดคล้องกัน
• เมื่อใดก็ตามที่จะมีการแสดงรายการหรือตาราง ผู้เขียนจะต้องมีการเกริ่นถึงสิ่งที่รายการหรือตารางจะนำเสนอเสมอ

Paragraphs

• เขียนประโยคเปิดหรือพารากราฟเปิดให้มีพลังซึ่งหมายถึงสามารถนำเสนอใจความสำคัญของเนื้อหาส่วนอื่นๆ ต่อไปได้
• หนึ่งพารากราฟหรือหนึ่งย่อหน้าควรนำเสนอหนึ่งประเด็นหรือไอเดีย ถ้าพารากราฟนั้นพูดถึงปัจจุบัน การพูดถึงอดีตและอนาคตในพารากราฟดังกล่าวก็ถือเป็นสิ่งต้องห้าม และควรแยกออกไปเป็นพารากราฟอื่น และไม่ควรยาวหรือสั้นจนเกินไปด้วย
• พารากราฟที่ดีจะต้องอธิบาย 3 ประเด็นนี้ได้คือ
  • What: อะไรที่เราอยากบอกแก่ผู้อ่าน
  • Why: ทำไมประเด็นนี้จึงสำคัญกับผู้อ่าน
  • How: ผู้อ่านจะเอาสิ่่งที่รู้ไปใช้ได้อย่างไร หรือผู้อ่านจะรู้ได้อย่างไรว่าประเด็นที่นำเสนอเป็นจริง

Audience

good documentation = knowledge and skills your audience needs to do a task − your audience’s current knowledge and skills

• การจัดการสารให้สอดคล้องกับผู้ต้องการของรับสารนั้นมักจะอยู่ที่กำหนดผู้รับว่ามี background เป็นอย่างไรส ประเมินความต้องการของผู้รับสารและสร้างสารที่เหมาะสมกับผู้รับ
• ให้ระวัง curse of knowledge หรือประเด็นในเรื่องของการมีพื้นฐานความเข้าใจที่แตกต่างกันระหว่าง expert และ novice โดยส่วนใหญ่ novice จะไม่ได้รู้สิ่งที่ expert รู้อยู่แล้วซึ่งทำให้การอธิบายในมุมของ expert ยากที่จะถูกเข้าใจจากในมุม novice
• พยายามสร้างเนื้อหาที่สามารถเข้าถึงได้จากทุกวัฒนธรรม หลีกเลี่ยงการเปรียบเปรยหรือการยกตัวอย่างที่สามารถทำความเข้าใจได้จากผู้คนซึ่งมาจากวัฒนธรรมเดียว โดยเฉพาะอย่างยิ่งการใช้ idiom หรือสำนวน

Documents

• เมื่อเราจัดทำเอกสารระบุให้ชัดเจนว่าเอกสารดังกล่าวจัดทำขึ้นมาด้วยจุดประสงค์ใด มี target audience เป็นใคร มีขอบเขตการอธิบายอย่างไร และประเด็นใดไม่อยู่ในขอบเขตการอธิบายของเอกสารนี้
• ไม่มีใครอยากอ่านเอกสารทั้งหมดเพื่อทำความเข้าใจ การสร้างเอกสารจึงควรมีเอกสารหนึ่งหน้าที่สรุปใจความสำคัญเอาไว้ในลักษณะทั้งแบบ Executive summary หรือ TLDR
• เราควรกำหนด target audience เพื่อใช้ในการกำหนดและจัดการเนื้อหาในเอกสาร โดยควรเริ่มจากสิ่งที่ผู้อ่านควรต้องรู้ก่อนจึงจะเข้าใจประเด็นสำคัญของเอกสารได้ แยกหัวข้อตามใจความสำคัญอย่างชัดเจน

Punctuation

Comma

• ใส่ comma ในจุดที่ผู้อ่านควรหยุดอ่านชั่วคราวเมื่ออ่านประโยค ตระหนักไว้เสมอว่าการหยุดจาก comma นั้นมีช่วงหยุดสั้นกว่าการหยุดโดย period หรือจุดที่ใส่ท้ายประโยค
• ในกรณีที่ประโยคนำเสนอเงื่อนไขและผลจากเงื่อนไขนั้น ให้ใส่ command ระหว่างเงื่อนไขและผลลัพธ์ของการทำตามเงื่อนไข เช่น
• หลีกเลี่ยงการใช้ comma เพื่อเชื่อมประโยคหรือใจความที่ไม่สัมพันธ์กัน

Semicolon

• เครื่องหมาย semicolon มีไว้ใช้เพื่อนรวมใจความที่คล้ายคลึงกันไว้ด้วยกัน โดยส่วนที่อยู่หลังเครื่องหมาย semicolon จะต้องเป็นประโยคที่มีไวยากรณ์ถูกต้อง
• การตรวจสอบการว่าการใช้ semicolon ถูกต้องหรือไม่สามารถทำได้จากการทดลองสลับตำแหน่งของส่วนที่อยู่หน้าและหลังเครื่องหมาย semicolon หากใจความยังเป็นเหมือนเดิมและเป็นประโยคที่ถูกต้องตามไวยากรณ์ก็แสดงให้เห็นว่าการใช้ semicolon ทำได้ถูกต้อง
• หากมีการใช้ semicolon ตามด้วยคำเชื่อมหรือ transition word ให้ตาม transition word ดังกล่าวด้วย comma

Em-Dashes

• Em-dashes หรือเครื่องหมาย — ใช้นำเสนอการหยุดซึ่งมีช่วงหยุดยาวกว่า comma แต่สั้นกว่าจุดท้ายประโยค โดยส่วนใหญ่การใช้ em-dashe จะเป็นไปในลักษณะของการขยายความ หรือแทรกเนื้อหาอื่นที่อาจไม่สอดคล้องตามประเด็นที่นำเสนออยู่ลงไป
• ไม่มีการกำหนดอย่างชัดเจนว่าในสถานการณ์ไหนควรใช้ comma หรือ em-dash

Parentheses

เครื่องหมายวงเล็บใช้เพื่อเสนอประเด็นย่อย ประเด็นเสริมหรือเนื้อหาที่ไม่สอดคล้องกับประเด็นหลัก เนื่องจากประเด็นส่วนใหญ่ที่นำเสนอในวงเล็บนั้นมีความสำคัญต่ำ ในบางครั้งเราจึงอาจไม่จำเป็นต้องใช้วงเล็บหรือลดการใช้ลงไปได้