วิธีการร่างเอกสารการเขียนทางเทคนิค

Anonim

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

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

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

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

จัดเรียงข้อมูลตามลำดับที่เหมาะสม เค้าร่างเกี่ยวข้องกับการจัดกลุ่มข้อมูลลงในส่วนตรรกะและระดับ คุณสามารถสร้างหัวข้อหลักและหัวข้อย่อยและหัวข้อย่อย

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