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

การเขียนเชิงเทคนิคเป็นรูปแบบการเขียนที่ต้องใช้ความพยายามอย่างมาก โดยต้องอาศัยการค้นคว้าวิจัยอย่างแม่นยำในเรื่องนั้นๆ และการแปลงข้อมูลที่รวบรวมได้ให้เป็นรูปแบบ สไตล์ และระดับการอ่านที่ผู้ใช้ปลายทางจะเข้าใจหรือเชื่อมโยงได้ง่าย การเขียนเชิงเทคนิคมีสองรูปแบบหลัก
ขั้นตอน
รูปแบบการเขียนทางเทคนิคที่พบได้บ่อยที่สุดคือการเขียนทางเทคนิคเชิงขั้นตอน ขั้นตอนต่างๆ นั้นเป็นเพียงคำแนะนำที่แบ่งออกเป็นขั้นตอนย่อยๆ ที่เข้าใจง่าย เพื่อให้มีประสิทธิภาพ ผู้เชี่ยวชาญและผู้อ่านทั่วไปต้องสามารถเข้าใจขั้นตอนเดียวกันได้อย่างเท่าเทียมกัน นี่คือเหตุผลที่ความถูกต้อง ความเป็นมาตรฐาน และความเรียบง่ายมีความสำคัญอย่างยิ่งในการเขียนรูปแบบนี้
- การเขียนเชิงเทคนิคแบบขั้นตอนถูกนำไปใช้ในวิทยาศาสตร์และอุตสาหกรรมทุกประเภททั่วโลก
- เอกสารทางเทคนิคมีรูปแบบการเขียนที่ใช้กันอย่างแพร่หลายเพื่ออธิบายวิธีการใช้งาน การประกอบ การติดตั้ง และขั้นตอนการทำงาน/ความปลอดภัยของบุคลากร (เช่นขั้นตอนการปฏิบัติงานมาตรฐาน )
ปัจจุบัน อุตสาหกรรมซอฟต์แวร์เป็นหนึ่งในอุตสาหกรรมที่ใช้เอกสารทางเทคนิคเชิงขั้นตอนมากที่สุด และอาศัยเอกสารเชิงขั้นตอนในการอธิบายวิธีการใช้งานและการติดตั้งโปรแกรม
วิทยาศาสตร์
รูปแบบการเขียนทางเทคนิคที่พบได้บ่อยเป็นอันดับสอง มักเรียกว่า การเขียนทางเทคนิคเชิงวิทยาศาสตร์ การเขียนทางเทคนิครูปแบบนี้เป็นไปตามมาตรฐานการเขียน " เอกสารไวท์เปเปอร์ " และใช้ในการทำการตลาดผลิตภัณฑ์/บริการเฉพาะทาง หรือความคิดเห็น/การค้นพบแก่ผู้อ่านที่เลือก[ 1 ]โดยปกติองค์กรจะใช้การเขียนทางเทคนิคเชิงวิทยาศาสตร์เพื่อเผยแพร่เอกสารไวท์เปเปอร์ในรูปแบบบทความวารสารอุตสาหกรรมหรือบทความวิชาการ[ 2 ]การเขียนทางเทคนิคเชิงวิทยาศาสตร์เขียนขึ้นเพื่อดึงดูดผู้อ่านที่คุ้นเคยกับหัวข้อทางเทคนิค แตกต่างจากการเขียนทางเทคนิคเชิงกระบวนการ เอกสารเหล่านี้มักมีคำศัพท์เฉพาะทางอุตสาหกรรม ข้อมูล และอคติที่ชัดเจนที่สนับสนุนข้อค้นพบ/จุดยืนของผู้เขียนหรือองค์กรที่เขียน[ 3 ]รูปแบบการเขียนทางเทคนิคประเภทที่สองนี้ต้องแสดงให้เห็นถึงความรู้เชิงลึกเกี่ยวกับเรื่องและสาขาการทำงาน โดยมีจุดประสงค์เดียวคือการโน้มน้าวให้ผู้อ่านเห็นด้วยกับข้อสรุปของเอกสาร[ 4 ]โดยทั่วไปนักเขียนทางเทคนิคจะเป็นผู้เขียน หรือเขียนเอกสารไวท์เปเปอร์ให้กับองค์กรหรือผู้เชี่ยวชาญในอุตสาหกรรม แต่แทบจะไม่ได้รับการให้เครดิตในฉบับที่ตีพิมพ์
องค์ประกอบพื้นฐาน
อย่างไรก็ตาม ในกรณีส่วนใหญ่ การเขียนเชิงเทคนิคใช้เพื่อช่วยถ่ายทอดหัวข้อทางวิทยาศาสตร์ที่ซับซ้อนหรือเฉพาะกลุ่มให้กับผู้ใช้ปลายทางที่มีระดับความเข้าใจที่หลากหลาย เพื่อให้แน่ใจว่าเนื้อหาเป็นที่เข้าใจได้สำหรับทุกคน จึง ใช้ภาษาที่เข้าใจง่าย ( Plain Language : PL) และให้เฉพาะเนื้อหาที่เป็นข้อเท็จจริงเท่านั้น การเขียนเชิงเทคนิคแบบขั้นตอนสมัยใหม่ใช้คำศัพท์ง่ายๆ และประโยคสั้นๆ แทนที่จะอธิบายรายละเอียดด้วยข้อมูลที่ไม่จำเป็น เช่นคำสรรพนามส่วนบุคคลคำนามนามธรรม และคำย่อ ที่ไม่คุ้นเคย เพื่อให้ได้ไวยากรณ์ที่ถูกต้อง เอกสารเชิงขั้นตอนจึงเขียนจากมุมมองบุคคลที่สามที่เป็นกลาง โดยใช้เสียงที่กระฉับกระเฉงและน้ำเสียงที่เป็นทางการ ไวยากรณ์ของการเขียนเชิงเทคนิคคล้ายคลึงกับการเขียนข่าวสิ่งพิมพ์และมีรูปแบบไวยากรณ์ที่คล้ายคลึงกันมาก[ 5 ]
แม้ว่าการเขียนเชิงเทคนิคจะมีบทบาทสำคัญในงานด้านวิศวกรรมการดูแลสุขภาพและวิทยาศาสตร์แต่ก็ไม่จำเป็นต้องมีปริญญาในสาขาเหล่านี้ แต่ผู้เขียนเอกสารจะต้องเป็นผู้เชี่ยวชาญด้านการเขียนเชิงเทคนิคผู้เชี่ยวชาญเฉพาะด้าน ขององค์กร ข้อกำหนดภายใน และกระบวนการตรวจสอบทางวิศวกรรมอย่างเป็นทางการจะถูกนำมาใช้เพื่อให้มั่นใจในความถูกต้อง บทบาทที่กำหนดไว้จะสร้างการแบ่งงาน ที่จำเป็น เพื่อให้เกิดความมุ่งเน้นมากขึ้นในสองด้านของเอกสารขององค์กร โดยทั่วไปแล้ว นักเขียนเชิงเทคนิคมีหน้าที่รับผิดชอบในการตรวจสอบให้แน่ใจว่ามีการใช้รูปแบบและการจัดรูปแบบที่ถูกต้อง ในขณะที่ผู้เชี่ยวชาญเฉพาะด้านจะตรวจสอบความถูกต้องนักเขียนเชิง เทคนิคส่วนใหญ่ สำเร็จ การศึกษาระดับ ปริญญาศิลปศาสตร์ในสาขาวิชาการเขียน เช่น การสื่อสารเชิงเทคนิค วารสารศาสตร์ ภาษาอังกฤษ วารสารศาสตร์เชิงเทคนิค การสื่อสาร ฯลฯ การเขียนเชิงเทคนิคเป็นส่วนที่ใหญ่ที่สุดของสาขาการสื่อสารเชิงเทคนิค[ 6 ]
ตัวอย่างสาขาที่ต้องการทักษะการเขียนเชิงเทคนิคได้แก่ฮาร์ดแวร์ และซอฟต์แวร์คอมพิวเตอร์สถาปัตยกรรมวิศวกรรมเคมีการบินและอวกาศหุ่นยนต์การผลิตการเงินการแพทย์กฎหมายสิทธิบัตรเครื่องใช้ไฟฟ้าเทคโนโลยีชีวภาพและวนศาสตร์
ภาพรวม
การเขียนเชิงเทคนิคส่วนใหญ่มักดำเนินการโดยนักเขียนเชิงเทคนิค ที่ได้รับการฝึกฝนมา และเนื้อหาที่พวกเขาสร้างขึ้นเป็นผลผลิตจากกระบวนการที่กำหนดไว้อย่างดีนักเขียนเชิงเทคนิคปฏิบัติตามแนวทางที่เข้มงวด ดังนั้นงานเขียนเชิงเทคนิคที่พวกเขานำเสนอจึงปรากฏในรูปแบบและสไตล์ที่เป็นมาตรฐานและเป็นที่นิยมใช้กันทั่วไป (เช่นDITA , รูปแบบ Markdown , AP Stylebook , Chicago Manual of Style ) งานหลักของนักเขียนเชิงเทคนิคคือการสื่อสารข้อมูลทางเทคนิคในวิธีที่ชัดเจนและมีประสิทธิภาพที่สุดเท่าที่จะเป็นไปได้[ 7 ] [ 8 ]เพื่อให้ได้ระดับความชัดเจนสูงสุด งานเขียนเชิงเทคนิคขององค์กรควรจะอ่านไม่ออกสำหรับผู้อ่าน โดยไม่มีการเปลี่ยนแปลงในรูปแบบ ไวยากรณ์ และ/หรือสไตล์ที่กำหนดไว้ระหว่างผู้เขียน หัวข้อของนักเขียนเชิงเทคนิคมักมีความซับซ้อน ดังนั้นทักษะการเขียนและการสื่อสารที่แข็งแกร่งจึงเป็นสิ่งจำเป็น การเขียนเชิงเทคนิคไม่ได้จำกัดอยู่เพียงการสื่อสารด้วยลายลักษณ์อักษรเท่านั้นการสื่อสารด้วยภาพมักถูกรวมเข้าไว้ในเอกสารเพื่อช่วยลดความซับซ้อนของหัวข้อที่ซับซ้อน นักเขียนเชิงเทคนิคใช้ซอฟต์แวร์แก้ไขภาพและกราฟิกที่ทันสมัยต่างๆ เพื่อสร้างการสื่อสารด้วยภาพ ซอฟต์แวร์สำหรับแก้ไขภาพประกอบแผนภาพ และ ภาพระเบิด CADเป็นเครื่องมือที่ใช้กันทั่วไปในวงการนี้[ 9 ]
ในบางกรณี วิศวกรอาจเป็นผู้เขียนเอกสารทางเทคนิคสำหรับโครงการที่ตนกำลังทำงานอยู่ แต่กรณีนี้เกิดขึ้นไม่บ่อยนักในองค์กรขนาดใหญ่ที่ต้องออกผลิตภัณฑ์หรือปรับปรุงแก้ไขทุกสัปดาห์ ในส่วนของธุรกิจนั้น โดยทั่วไปแล้วเอกสารทางการตลาดหรือข่าวประชาสัมพันธ์มักเขียนโดยนักเขียนที่ได้รับการฝึกฝนมาในด้านการตลาดและ/หรือการเขียนเชิงสร้างสรรค์ อย่างไรก็ตาม องค์กรอาจต้องการนักเขียนด้านเทคนิคเพื่อช่วยแก้ไขและให้ข้อเสนอแนะอื่นๆ เกี่ยวกับเนื้อหาทางเทคนิคใดๆ ก็ตาม
ประวัติศาสตร์
แม้ว่าการเขียนเชิงเทคนิคจะได้รับการยอมรับว่าเป็นวิชาชีพตั้งแต่หลังสงครามโลกครั้งที่สองแต่รากฐานของมันสามารถสืบย้อนไปได้ถึงอียิปต์โบราณ ซึ่งมีการใช้การสื่อสารด้วยภาพเพื่ออธิบายขั้นตอนต่างๆ เป็นประจำ ในสมัยกรีกและโรมันโบราณ งานเขียนเชิงเทคนิคของนักเขียนอย่างอริสโตเติลและเดโมคราตัสถูกยกให้เป็นตัวอย่างหนึ่งของรูปแบบการเขียนเชิงเทคนิคที่เก่าแก่ที่สุด ตัวอย่างแรกสุดของสิ่งที่ถือว่าเป็นงานเขียนเชิงเทคนิคแบบสมัยใหม่นั้นย้อนกลับไปถึงยุคของนักเล่นแร่แปรธาตุนักวิทยาศาสตร์ยุคแรกเหล่านี้ได้พัฒนาสิ่งที่เรารู้จักกันในปัจจุบันว่า " สูตร " การค้นพบขั้นตอนการเขียนที่เก่าแก่ที่สุดในอารยธรรมตะวันตกนั้นย้อนกลับไปถึงปี ค.ศ. 1100 อย่างไรก็ตาม การสื่อสารด้วยภาพถูกนำมาใช้เพื่ออธิบายขั้นตอนต่างๆ ในอินเดียและจีนโบราณมานานกว่านั้นแล้ว
ด้วยการประดิษฐ์แท่นพิมพ์ เชิงกล การเริ่มต้นของยุคฟื้นฟูศิลปวิทยาและการเกิดขึ้นของยุคแห่งเหตุผลการบันทึกผลการค้นพบจึงกลายเป็นสิ่งจำเป็น นักประดิษฐ์และนักวิทยาศาสตร์อย่างไอแซค นิวตันและเลโอนาร์โด ดา วินชีได้จัดทำเอกสารที่บันทึกสิ่งประดิษฐ์และผลการค้นพบของพวกเขา[ 10 ] : 1 แม้ว่าจะไม่เคยถูกเรียกว่าเอกสารทางเทคนิคในช่วงเวลาที่ตีพิมพ์ แต่เอกสารเหล่านี้มีบทบาทสำคัญในการพัฒนารูปแบบการสื่อสารและการเขียนทางเทคนิคสมัยใหม่[ 10 ]
สาขาการสื่อสารทางเทคนิคเติบโตขึ้นในช่วงการปฏิวัติอุตสาหกรรม[ 11 ] : 3 มีความต้องการเพิ่มมากขึ้นในการให้คำแนะนำแก่ผู้คนเกี่ยวกับการใช้เครื่องจักรที่ซับซ้อนมากขึ้นเรื่อยๆ ที่ถูกประดิษฐ์ขึ้น[ 11 ] : 8 อย่างไรก็ตาม ต่างจากในอดีตที่ทักษะต่างๆ ถูกถ่ายทอดผ่านประเพณีปากเปล่า ไม่มีใครนอกจากผู้ประดิษฐ์ที่รู้วิธีใช้เครื่องมือใหม่เหล่านี้การเขียนจึงกลายเป็นวิธีที่เร็วที่สุดและมีประสิทธิภาพที่สุดในการเผยแพร่ข้อมูล และนักเขียนที่สามารถบันทึกเครื่องมือเหล่านี้เป็นที่ต้องการ[ 11 ]
ในช่วงศตวรรษที่ 20 ความต้องการงานเขียนทางเทคนิคเพิ่มสูงขึ้นอย่างมาก และวิชาชีพนี้ได้รับการยอมรับอย่างเป็นทางการ เหตุการณ์ในสงครามโลกครั้งที่ 1และสงครามโลกครั้งที่ 2นำไปสู่ความก้าวหน้าในด้านการแพทย์ ยุทโธปกรณ์ทางทหาร เทคโนโลยีคอมพิวเตอร์ และเทคโนโลยีอวกาศ[ 10 ] : 2 การเติบโตอย่างรวดเร็วนี้ ประกอบกับความเร่งด่วนของสงคราม ทำให้เกิดความต้องการเอกสารที่ออกแบบมาอย่างดีเพื่อสนับสนุนการใช้เทคโนโลยีเหล่านี้ งานเขียนทางเทคนิคเป็นที่ต้องการอย่างมากในช่วงเวลานี้ และ "นักเขียนทางเทคนิค" กลายเป็นตำแหน่งงานอย่างเป็นทางการในช่วงสงครามโลกครั้งที่ 2 [ 10 ] : 1
หลังสงครามโลกครั้งที่สองความก้าวหน้าทางเทคโนโลยีทำให้สินค้าอุปโภคบริโภคและมาตรฐานการครองชีพเพิ่มสูงขึ้น[ 10 ] : 3 ในช่วงที่เศรษฐกิจเฟื่องฟูหลังสงคราม บริการสาธารณะ เช่น ห้องสมุดและมหาวิทยาลัย รวมถึงระบบขนส่ง เช่น รถโดยสารและทางหลวง ต่างก็มีการเติบโตอย่างมาก ความต้องการนักเขียนเพื่อบันทึกกระบวนการเหล่านี้จึงเพิ่มขึ้น[ 10 ] : 1 ในช่วงเวลานี้เองที่ธุรกิจขนาดใหญ่และมหาวิทยาลัยเริ่มใช้คอมพิวเตอร์ โดยเฉพาะอย่างยิ่ง ในปี 1949 โจเซฟ ดี. แชปลิน ได้เขียนเอกสารทางเทคนิคเกี่ยวกับการคำนวณฉบับแรก ซึ่งเป็นคู่มือการใช้งานคอมพิวเตอร์BINAC [ 12 ]
การประดิษฐ์ทรานซิสเตอร์ในปี พ.ศ. 2490 ทำให้สามารถผลิตคอมพิวเตอร์ได้ในราคาที่ถูกลงและอยู่ในช่วงราคาที่บุคคลทั่วไปและธุรกิจขนาดเล็กสามารถซื้อได้[ 10 ] : 3 เมื่อตลาดสำหรับ " คอมพิวเตอร์ส่วนบุคคล " เหล่านี้เติบโตขึ้น ความต้องการนักเขียนที่สามารถอธิบายและจัดทำเอกสารประกอบการใช้งานสำหรับอุปกรณ์เหล่านี้ก็เพิ่มขึ้นเช่นกัน[ 10 ] : 3 อาชีพนักเขียนด้านเทคนิคมีการขยายตัวมากขึ้นในช่วงทศวรรษ 1970 และ 1980 เนื่องจากอุปกรณ์อิเล็กทรอนิกส์สำหรับผู้บริโภคเข้ามาอยู่ในบ้านของผู้คนมากขึ้นเรื่อยๆ[ 10 ]
ในช่วงไม่กี่ปีที่ผ่านมา ความโดดเด่นของคอมพิวเตอร์ในสังคมได้นำไปสู่ความก้าวหน้ามากมายในด้านการสื่อสารดิจิทัล ซึ่งนำไปสู่การเปลี่ยนแปลงในเครื่องมือที่นักเขียนด้านเทคนิคใช้[ 10 ] : 3 ไฮเปอร์เท็กซ์ โปรแกรม ประมวลผลคำโปรแกรมแก้ไขกราฟิกและซอฟต์แวร์จัดวางหน้ากระดาษ ทำให้การสร้างเอกสารทางเทคนิคทำได้เร็วและง่ายขึ้น และนักเขียนด้านเทคนิคในปัจจุบันต้องมีความเชี่ยวชาญในโปรแกรมเหล่านี้[ 7 ] : 8–9
การประยุกต์ใช้หลักสูตรมหาวิทยาลัยในภาคอุตสาหกรรม
มหาวิทยาลัยได้สร้างหลักสูตรเฉพาะทางในการสอนการเขียนเชิงเทคนิคแก่นักศึกษา[ 13 ]อย่างไรก็ตาม อาจารย์ผู้สอนการเขียนเชิงเทคนิคในสถาบันการศึกษาบางคนไม่เคยสัมผัสกับสภาพแวดล้อมของสถานที่ทำงานระดับมืออาชีพมาก่อน จึงทำให้เกิดช่องว่างระหว่างสิ่งที่สอนในหลักสูตรของมหาวิทยาลัยกับสิ่งที่คาดหวังในที่ทำงาน เมื่อถูกถามถึงความจำเป็นของการเขียนเชิงเทคนิคในหลักสูตรของมหาวิทยาลัย วิศวกรการบินและอวกาศทั้งในสหรัฐอเมริกาและยุโรปต่างระบุว่านักศึกษาระดับปริญญาตรีควรต้องเรียนหลักสูตรการเขียนเชิงเทคนิค[ 14 ]นอกจากนี้ วิศวกรในสหรัฐอเมริกายังเน้นย้ำถึงความสำคัญของการรู้วิธีการเขียนเชิงเทคนิคและการสื่อสารไปยังกลุ่มเป้าหมายที่กว้างขึ้น เนื่องจากอุตสาหกรรมการบินและอวกาศโดยเฉพาะอย่างยิ่งยังคงเติบโตอย่างต่อเนื่องในระดับสากล[ 14 ]การเขียนเชิงเทคนิคยังไม่ได้รับการกำหนดมาตรฐานในระดับสากล จึงเป็นความท้าทายสำหรับอาจารย์ผู้สอนในการสอนนักศึกษาถึงวิธีการเขียนเชิงเทคนิคที่เป็นมาตรฐานซึ่งกลุ่มเป้าหมายในระดับสากลสามารถเข้าใจได้[ 15 ]
นักเรียนรู้สึกว่าทักษะการเขียนเชิงเทคนิคมีความสำคัญมากกว่าทักษะอื่นๆ เช่น การพูด/การสื่อสารด้วยวาจา การใช้ห้องสมุดที่มีแหล่งข้อมูลและสื่อข้อมูลด้านวิศวกรรม/วิทยาศาสตร์ การใช้แหล่งข้อมูลและสื่อข้อมูลด้านวิศวกรรม/วิทยาศาสตร์ การค้นหาฐานข้อมูลอิเล็กทรอนิกส์ และการใช้คอมพิวเตอร์ การสื่อสาร และเทคโนโลยีสารสนเทศ[ 16 ]แม้ว่าทักษะการเขียนเชิงเทคนิคจะมีความสำคัญค่อนข้างสูงเมื่อเทียบกับทักษะทางเทคนิคอื่นๆ แต่มีเพียงครึ่งหนึ่งของนักเรียนที่ได้รับการสอนการเขียนเชิงเทคนิคเท่านั้นที่ระบุว่าการสอนนั้นมีประโยชน์[ 16 ]เป็นที่น่าสังเกตว่าระดับและรูปแบบของการเขียนเชิงเทคนิคที่ใช้ในอุตสาหกรรมนั้นไม่ได้สะท้อนอยู่ในสื่อการเรียนการสอนของมหาวิทยาลัย เช่น ตำราเรียน[ 15 ]
ประกาศรับสมัครงานบางฉบับไม่ได้ระบุถึงความต้องการทักษะการเขียนเชิงเทคนิคโดยเฉพาะ แต่ระบุถึงความต้องการทักษะเฉพาะด้านในการทำงานกับเอกสารบางประเภทแทน[ 17 ]
เอกสารทางเทคนิค

งานเขียนเชิงเทคนิคครอบคลุมหลากหลายประเภทและรูปแบบการเขียน ขึ้นอยู่กับข้อมูลและกลุ่มเป้าหมาย ตัวอย่างเอกสารเชิงเทคนิคที่ใช้กันทั่วไป ได้แก่:
- เอกสารประกอบ API : ใช้เป็นหลักในด้านการพัฒนาเว็บเพื่อจัดทำเอกสารคำแนะนำการใช้งานและการแก้ไขแอปพลิเคชันเว็บแต่ละรายการโดยใช้Application Programming Interface (API)เครื่องมือ API ทั่วไป เช่นSwaggerและPostmanช่วยให้นักเขียนด้านเทคนิคสามารถสร้างเอกสารในรูปแบบ Markdownเพื่ออัปโหลดไปยังไดเร็กทอรี API เฉพาะที่มีโค้ดที่เกี่ยวข้อง (เช่น การแปลภาษา การเข้าสู่ระบบ ความปลอดภัย) ได้อย่างง่ายดาย โดยทั่วไปแล้ว เอกสารประกอบ API จะถูกแปลงเป็นรูปแบบ " Markdown " มาตรฐานโดยอัตโนมัติจากภายในตัวแก้ไข WYSIWYGของเครื่องมือ API ในกรณีส่วนใหญ่ นักเขียนด้านเทคนิคจะอัปโหลดการอัปเดตคำแนะนำซอฟต์แวร์ไปยังไดเร็กทอรีเมื่อมีการอัปเดตโค้ดใหม่ ไดเร็กทอรีเว็บไซต์มักจะถูกจัดเก็บและอัปเดตใน " Git " ซึ่งช่วยให้โปรแกรมเมอร์สามารถย้ายไดเร็กทอรีที่อัปเดตแล้วไปยังเซิร์ฟเวอร์ทดสอบและเซิร์ฟเวอร์ใช้งานจริงได้อย่างง่ายดาย
- คู่มือการประกอบ (AI) : จัดทำขั้นตอนภายในสำหรับบุคลากรในสายการประกอบ โดยจะเขียนขั้นตอนต่างๆ ไว้และมอบหมายให้สมาชิกในทีมประกอบแต่ละคน บ่อยครั้งที่ผู้เขียนคู่มือทางเทคนิคจะรวมภาพแยกชิ้นส่วนจากแบบจำลอง CAD เพื่อทำให้การประกอบที่ซับซ้อนเข้าใจง่ายขึ้น
- กรณีศึกษา : รายงานที่ตีพิมพ์เกี่ยวกับบุคคล กลุ่ม หรือสถานการณ์ที่ได้รับการศึกษาในช่วงเวลาหนึ่งรวมถึงสถานการณ์ในชีวิตจริงที่สามารถนำมาพิจารณาหรือศึกษาเพื่อเรียนรู้เกี่ยวกับบางสิ่งได้ [ 18 ]ในองค์กรขนาดใหญ่ นักเขียนด้านเทคนิคจะให้บริการแก้ไขต้นฉบับหรือเขียนแทนสำหรับกรณีศึกษาเท่านั้น โดยทั่วไปแล้วจำเป็นต้องมีผู้เขียนระดับบริหารเพื่อให้เป็นไปตามมาตรฐานและหลักเกณฑ์ของประเทศ
- คู่มือการบำรุงรักษาชิ้นส่วน (CMMs) : ส่วนใหญ่ใช้ในอุตสาหกรรมการบินและอวกาศ เพื่อแจ้งให้ลูกค้าทราบเมื่อใดก็ตามที่ชิ้นส่วนสำคัญต้องได้รับการซ่อมแซมหรือเปลี่ยนใหม่ เอกสารแจ้งเตือนการบริการที่เกี่ยวข้องกับชิ้นส่วนทั้งหมดจะต้องถูกรวมไว้และ/หรืออ้างอิงใน CMM พร้อมด้วยแบบร่างและข้อมูลชิ้นส่วนล่าสุด CMMs เป็นไปตามรูปแบบของสมาคมขนส่งทางอากาศยาน (ATA) และการแบ่งบท ตามข้อกำหนด ATA Spec 100/iSpec 2200
- คู่มือการติดตั้ง (IM) : ขั้นตอนต่างๆ ที่ออกแบบมาเพื่อช่วยให้ผู้ใช้ปลายทางติดตั้งผลิตภัณฑ์หรือโปรแกรมซอฟต์แวร์ในภาคสนาม
- รายงานการตรวจสอบ : รายงานนี้ใช้เป็นหลักในงานก่อสร้างอาคารขนาดใหญ่และงานวิศวกรรมโยธา โดยจะให้รายละเอียดเกี่ยวกับปัญหา/ข้อบกพร่องในการก่อสร้างที่ผู้ตรวจสอบภาคสนามตรวจพบในขั้นตอนต่างๆ ของโครงการ ปัญหา/ข้อบกพร่องที่พบจะถูกบันทึกไว้ในรายการตรวจสอบเบื้องต้น (punch list ) ผู้เขียนรายงานทางเทคนิคจะอ้างอิงจากรายการตรวจสอบนี้เพื่อเขียนรายงานการตรวจสอบ รายงานการตรวจสอบจะให้ภาพรายละเอียด ตำแหน่ง และคำอธิบายของปัญหา/ข้อบกพร่อง เพื่อให้ผู้รับเหมาสามารถเข้าใจวิธีการแก้ไขปัญหาหรือซ่อมแซมได้อย่างถูกต้องมากขึ้น ในบางกรณี อาจมีคำแนะนำในการแก้ไขปัญหาเพิ่มเติมด้วย
- ฐานความรู้หรือศูนย์ช่วยเหลือ : เว็บไซต์ให้ความช่วยเหลือออนไลน์ ออกแบบมาเพื่อให้บริการข้อมูลทางเทคนิคเกี่ยวกับผลิตภัณฑ์และ/หรือบริการแก่ผู้ใช้ เนื้อหาสำหรับเว็บไซต์เหล่านี้อาจถูกสร้างและอัปโหลดไปยังเว็บในรูปแบบ SGML, XML หรือ XHTML ระบบจัดการเนื้อหา (CMS) ถูกใช้ในการจัดการและอัปโหลดเว็บไซต์เหล่านี้
- รายการบรรจุภัณฑ์หรือรายการจัดส่ง : ระบุชิ้นส่วนที่จัดส่ง ข้อมูลความปลอดภัยของผลิตภัณฑ์ และข้อมูลติดต่อของผู้ผลิต
- เอกสารแจ้งเตือนการบริการ (Service Bulletins หรือ SBs) : ส่วนใหญ่ใช้ในอุตสาหกรรมการบินและอวกาศ เพื่อแจ้งให้ลูกค้าทราบเมื่อใดก็ตามที่อาจจำเป็นต้องมีการซ่อมแซมและ/หรือดัดแปลงชิ้นส่วนเล็กๆ ของส่วนประกอบ ผู้ผลิตจะเป็นผู้จัดทำและออก SBs ให้แก่เจ้าของเครื่องบิน SBs เป็นไปตามรูปแบบของสมาคมขนส่งทางอากาศยาน (Aerospace Transport Association หรือ ATA) และการแบ่งบท ตามข้อกำหนด ATA Spec 100/iSpec 2200
- ข้อกำหนดหรือสเปค : ใช้ในอุตสาหกรรมการก่อสร้างเพื่อระบุมาตรฐานขั้นต่ำและข้อกำหนดในการติดตั้ง โดยปกติแล้ว ผู้จัดการโครงการจะเป็นผู้จัดเตรียมข้อกำหนดให้กับผู้รับเหมา และผู้รับเหมาจะต้องลงนามและยอมรับข้อกำหนดเหล่านั้นในฐานะส่วนหนึ่งของสัญญา มาตรฐานการจัดรูปแบบกำหนดโดยสถาบันข้อกำหนดการก่อสร้าง (Construction Specifications Institute - CSI )
- เอกสารข้อมูลจำเพาะ / เอกสารรายละเอียด / เอกสารข้อมูลผลิตภัณฑ์ : เอกสารอ้างอิงหนึ่งหรือสองหน้า ออกแบบมาเพื่อระบุคุณลักษณะทั่วไปของผลิตภัณฑ์/บริการที่จำเป็นสำหรับการใช้งานเฉพาะด้าน คุณลักษณะสูงสุดและต่ำสุดของผลิตภัณฑ์/บริการทั่วไปอาจรวมถึง: ขนาดและฐานติดตั้ง น้ำหนัก ประเภทการเชื่อมต่อหรืออินเทอร์เฟซ ข้อกำหนดทางไฟฟ้า ความเร็ว ฯลฯ
- ขั้นตอนการปฏิบัติงานมาตรฐาน (SOPs) : ขั้นตอนต่างๆ ที่บุคลากรทางการทหาร การผลิต การแพทย์ และความปลอดภัยทางอุตสาหกรรมใช้เป็นแนวทางในการประกอบ การแปรรูป หรือภารกิจงานอื่นๆ ที่ต้องดำเนินการตามลำดับที่ถูกต้อง
- รายงานการสำรวจ : เอกสารที่ครอบคลุมเกี่ยวกับการสำรวจที่ดิน ซึ่งจัดทำขึ้นจากภาพถ่ายและข้อมูลทางเทคนิคที่รวบรวมและสรุปโดยผู้สำรวจ
- เนื้อหาการตลาดเชิงเทคนิค : ข้อมูลที่เขียนขึ้นเพื่อวัตถุประสงค์ทางการตลาดโดยเฉพาะ เนื้อหาประเภทนี้มักใช้เพื่อช่วยอธิบายข้อมูลผลิตภัณฑ์และข้อกำหนดต่างๆ ในเอกสารทางการตลาดและในหน้าเว็บของผลิตภัณฑ์/บริการ โดยทั่วไปแล้ว นักเขียนเชิงสร้างสรรค์ที่เชี่ยวชาญด้านการตลาดจะถูกว่าจ้างให้ทำงานนี้
- คู่มือผู้ใช้ (UM)หรือคู่มือการใช้งาน : คำแนะนำขั้นตอนการใช้งานผลิตภัณฑ์หรือโปรแกรม
- เอกสารไวท์เปเปอร์ : เอกสารทางการตลาดที่มักเขียนโดยนักเขียนด้านเทคนิคและอ้างอิงถึงผู้เชี่ยวชาญในสาขานั้นๆ เอกสารไวท์เปเปอร์ทุกฉบับจะมีหัวข้อที่น่าสนใจและนำเสนอข้อโต้แย้งที่สนับสนุนข้อสรุปของผู้เชี่ยวชาญ
เครื่องมือ
เครื่องมือต่อไปนี้เป็นเครื่องมือที่นักเขียนด้านเทคนิคใช้ในการเขียนและนำเสนอเอกสาร:
- การสร้างภาพ CAD : นักเขียนด้านเทคนิคที่ทำงานด้านวิศวกรรมเครื่องกลมักใช้เครื่องมือสร้างภาพ CAD เพื่อ "แยกส่วน" แบบจำลอง 3 มิติที่สร้างและได้รับการอนุมัติจากฝ่ายวิศวกรรม เป้าหมายคือการสื่อสารขั้นตอนการประกอบ/ถอดชิ้นส่วนให้ชัดเจนยิ่งขึ้น โดยปกติจะใช้ซอฟต์แวร์ CAD สำหรับการสื่อสารทางเทคนิคเฉพาะทางเพื่อแก้ไขแบบจำลอง CAD ที่มีอยู่แล้ว
- โปรแกรมซอฟต์แวร์สำหรับการทำงานร่วมกันการเขียนเชิงเทคนิคต้องอาศัยความร่วมมือระหว่างหลายฝ่ายจากแผนกต่างๆ ภายในองค์กร [ 7 ] : 57 เพื่อเพิ่มการสื่อสารระหว่างฝ่ายต่างๆ นักเขียนเชิงเทคนิคจึงอาศัยระบบวิกิเช่น Confluenceและพื้นที่ทำงานเอกสารร่วมกัน [ 7 ] : 74
- ระบบจัดการเนื้อหา (CMS):การเขียนเชิงเทคนิคสมัยใหม่จะได้รับการแก้ไขและเผยแพร่ในระบบ CMS หรือ CCMSที่ออกแบบมาสำหรับการเขียนเชิงเทคนิคโดยเฉพาะ ระบบ CMS ใช้ในการเผยแพร่เนื้อหาเชิงเทคนิคจำนวนมากทางออนไลน์ได้อย่างง่ายดายและรวดเร็ว เนื้อหาที่อัปโหลดจะถูกแปลงเป็นระบบช่วยเหลือ "ฐานความรู้" โดยอัตโนมัติเพื่อให้ผู้ใช้ปลายทางใช้อ้างอิง นอกเหนือจาก คุณสมบัติการแก้ไขแบบ WYSIWYG พื้นฐาน และการอัปโหลดเว็บแล้ว ระบบ CMS ยังมีคุณสมบัติการจัดการเนื้อหาพร้อมการจัดการเวอร์ชันและเครื่องมือในตัวเพื่อจัดการเวิร์กโฟลว์เอกสารขนาดใหญ่ ระบบ CMS ส่วนใหญ่ที่ใช้สำหรับการเขียนเชิงเทคนิคจะใช้ SGML , XMLหรือ XHTMLเป็นพื้นฐาน
- เครื่องมือจัดพิมพ์เอกสารบนเดสก์ท็อปหรือโปรแกรมประมวลผลคำ : ในช่วงทศวรรษ 1990 การเขียนเอกสารทางเทคนิคส่วนใหญ่ดำเนินการโดยใช้เครื่องมือประมวลผลคำ โปรแกรมรุ่นแรกๆ เหล่านี้ช่วยให้นักเขียนทางเทคนิคสามารถเขียน แก้ไข ออกแบบ และพิมพ์เอกสารจากคอมพิวเตอร์ได้ โดยทั่วไปแล้ว ผู้เขียนเอกสารไวท์เปเปอร์ยังคงพึ่งพาโปรแกรมประมวลผลคำและเครื่องมือจัดพิมพ์เอกสารบนเดสก์ท็อปขั้นสูงเพื่อแก้ไขเอกสารของตน [ 19 ]
- ซอฟต์แวร์กราฟิก : รูปภาพและองค์ประกอบภาพอื่นๆ ถูกนำมาใช้ในการเขียนเชิงเทคนิคเพื่อช่วยสื่อสารข้อมูลในรูปแบบที่เข้าใจง่ายกว่าข้อความที่พิมพ์ [ 7 ] : 306–307 ในกรณีเหล่านี้ ซอฟต์แวร์กราฟิกที่นิยมใช้กันทั่วไปถูกนำมาใช้ในการเขียนเชิงเทคนิคเพื่อสร้างและแก้ไของค์ประกอบภาพของเอกสาร (เช่น รูปภาพ ไอคอน แผนภาพ ฯลฯ)
- ซอฟต์แวร์สร้างกราฟในการสื่อสารข้อมูลทางสถิติ การเขียนเชิงเทคนิคมักจะรวมถึงกราฟและผังงาน[ 7 ] : 306–307 ซอฟต์แวร์ฐานข้อมูลที่เป็นที่นิยมมักใช้ในการสร้างกราฟและแผนภูมิพื้นฐาน ในบางครั้ง การเขียนเชิงเทคนิคต้องจัดเตรียมกราฟที่ซับซ้อนมากขึ้นพร้อมคุณสมบัติแบบโต้ตอบออนไลน์ ซอฟต์แวร์สร้างกราฟฐานข้อมูล SQL มักใช้ในการทำงานนี้[ 20 ]
- เครื่องมือจับภาพหน้าจอ:การเขียนทางเทคนิคสำหรับขั้นตอนซอฟต์แวร์มักจะรวมถึงการจับภาพหน้าจอ[ 21 ] [ 22 ]การจับภาพหน้าจอมีสองประเภท ได้แก่ ภาพนิ่งและวิดีโอ การจับภาพหน้าจอแบบภาพนิ่งเป็นที่นิยมใช้ในอุตสาหกรรมซอฟต์แวร์ นักเขียนทางเทคนิคมักจะรวมการจับภาพหน้าจอแบบภาพนิ่งเพื่อช่วยอธิบายขั้นตอนที่ซับซ้อนมากขึ้น บางครั้ง นักเขียนทางเทคนิคอาจบันทึกวิดีโอสั้นๆ ของเดสก์ท็อปเพื่อแสดงขั้นตอนซอฟต์แวร์ อย่างไรก็ตาม วิธีนี้ไม่ค่อยเป็นที่นิยมเนื่องจากซอฟต์แวร์มีการแก้ไขหลายครั้ง
- ซอฟต์แวร์กำหนดคุณสมบัติ:ซอฟต์แวร์กำหนดคุณสมบัติแบบคลาวด์มักถูกใช้โดย "ผู้กำหนดคุณสมบัติ/ผู้เขียนด้านเทคนิค" เพื่อเลือกรายการมาตรฐานขั้นต่ำทั่วไปที่จำเป็นสำหรับโครงการก่อสร้าง โปรแกรมเหล่านี้มักได้รับการจัดรูปแบบให้สอดคล้องกับมาตรฐาน ของ สถาบันกำหนดคุณสมบัติการก่อสร้าง (CSI)
รายชื่อสมาคม
- สมาคมนักเขียนทางการแพทย์แห่งอเมริกา
- สถาบันมาตรฐานการก่อสร้าง (CSI)
- สมาคมการสื่อสารทางเทคนิคแห่งสาธารณรัฐเช็ก
- สมาคมการสื่อสารทางเทคนิคแห่งยุโรป
- สมาคมการสื่อสารระดับมืออาชีพของ IEEE
- สถาบันนักสื่อสารวิทยาศาสตร์และเทคโนโลยี
- สมาคมนักสื่อสารธุรกิจระหว่างประเทศ
- องค์กรเพื่อการพัฒนามาตรฐานข้อมูลที่มีโครงสร้าง (OASIS) - DITA
- SIGDOC
- สมาคมการสื่อสารทางเทคนิค (ยุบเลิกแล้วตั้งแต่ปี 2025)
ลิงก์ภายนอก
- โครงการอบรมการเขียนเชิงเทคนิค - สาขาลอสแอนเจลิสสมาคมการสื่อสารเชิงเทคนิค (LASTC)
- วารสาร IEEE ว่าด้วยการสื่อสารระดับมืออาชีพ
- หลักสูตรการเขียนเชิงเทคนิคจากWikiversity
สรุปเนื้อหา
ข้อมูลสำคัญจากบทความ
ข้อมูลสำคัญเกี่ยวกับ การเขียนเชิงเทคนิค
การเขียนเชิงเทคนิคเป็นรูปแบบการสื่อสารเฉพาะทางที่ใช้โดยองค์กรอุตสาหกรรมและวิทยาศาสตร์ เพื่อถ่ายทอดข้อมูลที่ซับซ้อนให้ลูกค้า พนักงาน ผู้ประกอบชิ้นส่วนวิศวกร...
ขั้นตอน
รูปแบบการเขียนทางเทคนิคที่พบได้บ่อยที่สุดคือการเขียนทางเทคนิคเชิงขั้นตอน ขั้นตอนต่างๆ นั้นเป็นเพียงคำแนะนำที่แบ่งออกเป็นขั้นตอนย่อยๆ ที่เข้าใจง่าย เพื่อให้มีประสิทธิภาพ ผู้เชี่ยวชาญและผู้อ่านทั่วไปต้องสามารถเข้าใจขั้นตอนเดียวกันได้อย่างเท่าเทียมกัน...
วิทยาศาสตร์
รูปแบบการเขียนทางเทคนิคที่พบได้บ่อยเป็นอันดับสอง มักเรียกว่า การเขียนทางเทคนิคเชิงวิทยาศาสตร์ การเขียนทางเทคนิครูปแบบนี้เป็นไปตามมาตรฐานการเขียน " เอกสารไวท์เปเปอร์ " และใช้ในการทำการตลาดผลิตภัณฑ์/บริการเฉพาะทาง หรือความคิดเห็น/การค้นพบแก่ผู้อ่านที่เลือก [ 1...
องค์ประกอบพื้นฐาน
อย่างไรก็ตาม ในกรณีส่วนใหญ่ การเขียนเชิงเทคนิคใช้เพื่อช่วยถ่ายทอดหัวข้อทางวิทยาศาสตร์ที่ซับซ้อนหรือเฉพาะกลุ่มให้กับผู้ใช้ปลายทางที่มีระดับความเข้าใจที่หลากหลาย เพื่อให้แน่ใจว่าเนื้อหาเป็นที่เข้าใจได้สำหรับทุกคน จึง ใช้ภาษาที่เข้าใจง่าย ( Plain Language : PL)...