องค์ประกอบพื้นฐานของการเขียนเชิงเทคนิค

การเขียนทางเทคนิคเป็นรูปแบบเฉพาะของการเขียน

เป้าหมายของมันคือการช่วยให้ผู้อ่านใช้เทคโนโลยีหรือเพื่อทำความเข้าใจกระบวนการผลิตภัณฑ์หรือแนวคิด บ่อยครั้งที่กระบวนการผลิตผลิตภัณฑ์หรือแนวความคิดเหล่านี้มีความซับซ้อน แต่ต้องมีรูปแบบที่เรียบง่ายและง่ายต่อการอ่านมากขึ้น

ดังนั้นในประเภทการเขียนทางเทคนิคคุณจะพบ: ข้อเสนอเอกสารขาวความช่วยเหลือออนไลน์มาตรฐานกระบวนการคำแนะนำและขั้นตอนการทำงาน

ในขณะที่แต่ละระเบียบมีความต้องการเฉพาะบางองค์ประกอบพื้นฐานเป็นเรื่องปกติ แต่ก่อนที่จะมองไปที่สิ่งเหล่านั้นสิ่งที่สำคัญที่สุดที่นักเขียนด้านเทคนิคจะต้องพิจารณาคือผู้ชม

ผู้ชม:

• เรื่องและข้อกำหนดเฉพาะและคำย่อที่คุณต้องใช้
• วิธีที่ดีที่สุดในการอธิบายคำเหล่านี้หรือแบบย่อ – เชิงอรรถท้ายคำศัพท์ตารางคำย่อภาคผนวกลิงก์
• คุณต้องการที่จะรองรับผู้อ่านสำรอง (เช่นผู้จัดการหรือนักการเงินที่จะตัดสินใจเกี่ยวกับข้อเสนอนี้) และคุณจะทำอย่างไร

Clarity – การไหลลื่นแบบตรรกะของเอกสารจะช่วยให้ผู้อ่านเข้าใจเนื้อหา อาจเป็นประโยชน์ที่จะขอให้คนที่ไม่คุ้นเคยกับหัวข้อนี้เพื่อทบทวนการเขียนของคุณก่อนที่จะจบการทำงาน การใช้หัวเรื่องภาพประกอบกราฟหรือตารางจะเป็นประโยชน์ – เป้าหมายของคุณคือทำให้ผู้อ่านเข้าใจได้ง่ายที่สุดเท่าที่จะเป็นไปได้ พิจารณาวิธีการที่ข้อความนั่งอยู่บนหน้าหรือหน้าจอ – เบาะแสเพื่อเพิ่มความชัดเจนให้กับผู้อ่านของคุณ

ความถูกต้อง – ข้อมูลและการตีความข้อมูลที่คุณนำเสนอต้องมีความถูกต้อง หากยังไม่ได้อ่านของคุณจะตั้งคำถามเกี่ยวกับความน่าเชื่อถือของเนื้อหา ระวังแยกแยะความแตกต่างระหว่างความเป็นจริงกับความคิดเห็นและอ้างอิงถึงงานอื่นได้อย่างถูกต้อง

ความกะทัดรัด – มุ่งมั่นที่จะหาสมดุลระหว่างจำนวนข้อมูลที่นำเสนอและเวลาที่จำเป็นในการอ่านเอกสาร โปรดจำไว้ว่าคุณสามารถใช้ภาคผนวกหรือลิงก์เพื่อให้ข้อมูลเพิ่มเติมหรือข้อมูลเบื้องหลัง ลองใช้ภาพประกอบตารางหรือกราฟแทนคำอธิบายแนวคิด – แต่จำไว้ว่าถ้าคุณใช้ "ภาพ" อย่าให้คำอธิบายเป็นลายลักษณ์อักษรยาว

ความยาวประโยค – โดยทั่วไปแนวคิดที่ซับซ้อนหรือไม่คุ้นเคยจะปรากฏในประโยคที่สั้นที่สุด สิ่งนี้จะช่วยให้ผู้อ่านสามารถแยกแยะข้อมูลขนาดเล็กก่อนที่จะดำเนินการต่อไป แม้ว่าจะเป็นเรื่องยากที่จะบรรลุเป้าหมายให้พยายามประมาณ 25 คำต่อประโยค ถ้าคุณพบว่าคุณได้เขียนประโยคยาว ๆ ให้มองหา 'และ', 'แต่', 'อย่างไรก็ตาม' และคำที่คล้ายกันซึ่งคุณสามารถแบ่งประโยคได้

ย่อหน้า – กฎที่เก่าแก่เกี่ยวกับหัวข้อหนึ่งต่อวรรคเป็นคำแนะนำที่มีประโยชน์ ไม่ได้หมายความว่าคุณสามารถมีได้เพียงย่อหน้าเดียวสำหรับแต่ละหัวข้อ แต่ก็หมายความว่ามีเพียงหัวข้อเดียวในแต่ละย่อหน้าเท่านั้นที่ทำให้การเขียนเชิงตรรกะชัดเจน

Reader-centricity – คุณกำลังเขียนให้ผู้อ่านของคุณ ทำให้มันเป็นไปได้ง่ายสำหรับพวกเขาที่จะเข้าใจการทำงานของคุณ

เก็บองค์ประกอบพื้นฐานเหล่านี้และหลักการอื่น ๆ ในใจในขณะที่คุณดำเนินงานเขียนทางเทคนิคของคุณ

Source by Desolie Page