One of the most common and one of t

One of the most common and one of the most important uses of technical writing is instructions—those step-by-step explanations of how to do things: assemble something, operate something, repair something, or do routine maintenance on something. But for something seemingly so easy and intuitive, instructions are some of the worst-written documents you can find. Like me, you've probably had many infuriating experiences with badly written instructions. What follows in this chapter may not be a fool-proof, goof-proof guide to writing instructions, but it will show you what professionals consider the best techniques.

Ultimately, good instruction writing requires:

Clear, simple writing
A thorough understanding of the procedure in all its technical detail
Your ability to put yourself in the place of the reader, the person trying to use your instructions
Your ability to visualize the procedure in great detail and to capture that awareness on paper
Finally, your willingness to go that extra distance and test your instructions on the kind of person you wrote them for.
By now, you've probably studied headings, lists, and special notices—writing a set of instructions with these tools probably seems obvious. Just break the discussion out into numbered vertical lists and throw in some special notices at the obvious points and you're done! Well, not quite, but that's a great start. This chapter explores some of the features of instructions that can make them more complex. You can in turn use these considerations to plan your own instructions.

ผลลัพธ์ (ไทย) 1:

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

ผลลัพธ์ (ไทย) 2:

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

ผลลัพธ์ (ไทย) 3:

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

ในที่สุด การเขียนการสอนที่ดีต้อง :


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