อุตสาหกรรมเทคโนโลยีเผชิญกับปัญหาที่ยืดเยื้อซึ่งรบกวนนักพัฒนามาหลายปี แม้ว่าเอกสารทางเทคนิคจะติดอันดับหนึ่งในสามของแหล่งเรียนรู้ยอดนิยมในการสำรวจของ Stack Overflow ปี 2024 แต่คุณภาพยังคงแย่อย่างน่าหงุดหงิด การสำรวจ Open Source ของ GitHub ในปี 2017 ระบุว่าเอกสารที่ไม่สมบูรณ์หรือสับสนเป็นจุดเจ็บปวดอันดับหนึ่งของนักพัฒนา และการสนทนาในชุมชนแสดงให้เห็นว่าสถานการณ์ไม่ได้ดีขึ้นเท่าไหร่นับตั้งแต่นั้น
สถิติสำคัญ:
- เอกสารทางเทคนิคติดอันดับ 3 อันดับแรกของแหล่งเรียนรู้ (การสำรวจของ Stack Overflow ปี 2024)
- "เอกสารที่ไม่สมบูรณ์หรือทำให้สับสน" เป็นจุดเจ็บปวด 1 อันดับ (การสำรวจ Open Source ของ GitHub ปี 2017)
ปัญหาจริงไม่ได้อยู่ที่ทักษะการเขียนเท่านั้น
แม้ว่าหลายคนจะคิดว่าเอกสารที่แย่เกิดจากนักพัฒนาขาดความสามารถในการเขียน แต่ชุมชนเผยให้เห็นภาพที่ซับซ้อนกว่านั้น ปัญหาหลักดูเหมือนจะเป็นสิ่งที่ผู้เชี่ยวชาญเรียกว่าปัญหาจิตใจผู้เริ่มต้น ซึ่งเป็นความล้มเหลวในการเข้าใจผู้อื่น นักพัฒนาดิ้นรนที่จะจำได้ว่าเป็นอย่างไรก่อนที่พวกเขาจะเข้าใจแนวคิดหนึ่ง ทำให้เกือบเป็นไปไม่ได้ที่จะแนะนำผู้อื่นผ่านการเรียนรู้เดียวกันนั้น
ผู้เชี่ยวชาญด้านการเขียนเทคนิคเน้นย้ำว่าร้อยแก้วที่สวยงามไม่มีความหมายอะไรหากเนื้อหาไม่ได้ให้บริการผู้อ่านที่ตั้งใจไว้ ความท้าทายที่ใหญ่ที่สุดไม่ใช่การสร้างประโยคที่สง่างาม แต่เป็นการวิเคราะห์ว่าใครจะอ่านเอกสารและออกแบบสิ่งที่พวกเขาต้องการเพื่อบรรลุเป้าหมาย สิ่งนี้ต้องการความเข้าใจในขั้นตอนการทำงานของผู้ใช้ การคาดการณ์ช่องว่างความรู้ และการจัดโครงสร้างข้อมูลในลำดับที่มีเหตุผล
ข้อดีและข้อเสียของเอกสาร LLM:
ข้อดี:
- มีการจัดโครงสร้างที่ดีกว่าเอกสารที่เขียนโดยนักพัฒนาหลายฉบับ
- มีการจัดรูปแบบที่สม่ำเสมอและปฏิบัติตามเทมเพลต
- เหมาะสำหรับเนื้อหาที่เป็นแบบแผนเช่นเอกสารการออกแบบ
ข้อเสีย:
- เนื้อหายากต่อการจดจำและเก็บรักษาไว้ในความทรงจำ
- ขาดบุคลิกภาพและ "บรรยากาศ" ที่น่าสนใจ
- อาจถูกต้องทางเทคนิคแต่ขาดคำอธิบายที่เข้าใจง่าย
องค์กรที่ทำได้ถูกต้อง
บางบริษัทได้แก้ปัญหานี้ผ่านกลยุทธ์ทางจิตวิทยาที่ชาญฉลาด วิธีการหนึ่งคือการมีทีมเอกสารเฉพาะที่จะเขียนเอกสารให้กับนักพัฒนาที่ไม่ได้จัดเตรียมเอกสารเอง อย่างไรก็ตาม ทีมเหล่านี้จงใจเขียนจากมุมมองของบุคคลภายนอก บังคับให้นักพัฒนาต้นฉบับใช้เวลาในการตรวจสอบและแก้ไขมากกว่าที่พวกเขาจะใช้เวลาเขียนเอกสารที่เหมาะสมด้วยตนเอง สิ่งนี้สร้างแรงจูงใจที่ถูกต้องในขณะที่รับประกันผลลัพธ์ที่มีคุณภาพ
แนวทางแก้ไขระดับองค์กร:
- รวบรวมข้อเสนอแนะจากผู้ใช้เอกสารอย่างสม่ำเสมอ
- เพิ่มนักเขียนเทคนิคเฉพาะทางเพื่อสนับสนุนทีมงาน
- ให้ความสำคัญกับปัญหาที่เกี่ยวข้องกับเอกสารใน GitHub issues
- ใช้ทีมเอกสาร "จิตวิทยาย้อนกลับ" ที่บังคับให้นักพัฒนาเข้ามามีส่วนร่วม
การถกเถียงเรื่องเอกสาร LLM
เมื่อเครื่องมือปัญญาประดิษฐ์มีความซับซ้อนมากขึ้น หลายคนหวังว่าพวกมันจะแก้ปัญหาเอกสาร วิศวกรบางคนรายงานว่าเอกสารที่สร้างโดย LLM มีประสิทธิภาพเหนือกว่าความพยายามในการเขียนเทคนิคก่อนหน้านี้อย่างมาก โดยเฉพาะสำหรับเนื้อหาที่มีโครงสร้างเช่นเอกสารออกแบบวิศวกรรมเครือข่าย เครื่องมือเหล่านี้เก่งในการปฏิบัติตามแม่แบบและรักษาการจัดรูปแบบที่สม่ำเสมอ
อย่างไรก็ตาม รูปแบบที่น่ากังวลเกิดขึ้นจากประสบการณ์ของนักพัฒนากับเอกสารที่สร้างโดย AI หลายคนพบว่าเนื้อหายากที่จะจำได้และไม่น่าสนใจเท่ากับทางเลือกที่เขียนโดยมนุษย์ การเพิ่มประสิทธิภาพทางคณิตศาสตร์ที่ขับเคลื่อน LLMs อาจผลิตเนื้อหาที่ถูกต้องทางเทคนิคแต่ไร้จิตวิญญาณซึ่งขาดบุคลิกภาพและคำอธิบายที่เข้าใจง่ายที่ทำให้แนวคิดทางเทคนิคติดอยู่ในใจ
AI ไร้เสน่ห์อย่างสิ้นเชิง และฉันมีความคิดว่าสิ่งที่ผู้คนชื่นชอบจากการเขียนเทคนิคคือบรรยากาศที่พวกเขาได้รับจากการเขียน มากเท่ากับคำแนะนำ
วิธีแก้ปัญหาน่าจะเกี่ยวข้องกับการปฏิบัติต่อเอกสารเป็นทั้งความท้าทายทางเทคนิคและความคิดสร้างสรรค์ องค์กรต้องการนักเขียนเทคนิคเฉพาะ ลูปการตอบรับอย่างสม่ำเสมอกับผู้ใช้จริง และนักพัฒนาที่ตระหนักว่าการอธิบายแนวคิดที่ซับซ้อนต้องการชุดทักษะของตัวเอง ในขณะที่ LLMs อาจจัดการการจัดรูปแบบและโครงสร้าง องค์ประกอบของมนุษย์ในการเข้าใจและเอาใจใส่ยังคงไม่สามารถแทนที่ได้สำหรับการสื่อสารทางเทคนิคที่มีประสิทธิภาพอย่างแท้จริง
อ้างอิง: Let's Talk About Writing in Tech