Cluedoc: สกิลเอเจนต์สำหรับเขียนเอกสารเพื่อช่วยทำความเข้าใจ codebase

คุณเคยเหนื่อยล้ากับโค้ดที่ coding agent ผลิตออกมาไม่หยุดหรือเปล่า? จนถึงขั้นเลิกพยายามทำความเข้าใจซอฟต์แวร์ของคุณไปแล้วหรือไม่?

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

นั่นจึงเป็นเหตุผลที่เราสร้าง Cluedoc ขึ้นมา Cluedoc คือ Agent Skill ที่ทำให้ coding agent เขียนเอกสารที่มนุษย์อ่านเข้าใจง่าย เอกสารของ Cluedoc ถูกสร้างมาเพื่อให้อ่านได้จริง โดยตัดรายละเอียดเชิงเทคนิคออกและโฟกัสที่แนวคิดระดับสูง

Cluedoc มองระบบเป็นต้นไม้ของฟีเจอร์ (feature) และเขียนเอกสาร (paper) หนึ่งฉบับต่อหนึ่งฟีเจอร์ เอกสารอยู่ภายใน codebase ในรูปแบบ Markdown ล้วน และถูกอัปเดตให้ทันสมัยอยู่เสมอภายในลูปการทำงาน ไม่ต้องมีเซิร์ฟเวอร์ และไม่ต้องมีฐานข้อมูล

หน้า landing page ที่ลิงก์ไว้นั้นเองก็เป็นเอกสาร Cluedoc ที่เขียนเกี่ยวกับ Cluedoc นอกจากนี้ยังมีเอกสารตัวอย่างที่สร้างขึ้นสำหรับ Flask, Cobra และ Commander ให้ลองเข้าไปดูได้