Cluedoc: कोडबेस को समझने में मदद करने वाला डॉक्यूमेंटेशन-लेखन एजेंट स्किल
(keunwoopark.github.io)क्या आप कोडिंग एजेंट द्वारा लगातार उगले जा रहे कोड से थक चुके हैं? क्या इस वजह से आपने अपने सॉफ़्टवेयर को समझने की कोशिश ही छोड़ दी है?
जब एजेंट कोड लिखता है, तो उसे समझना सबसे महत्वपूर्ण काम बन जाता है। आपने खुद एक भी लाइन टाइप नहीं की, कोडबेस लगातार बदल रहा है, तो फिर आप कैसे जानेंगे कि सिस्टम वास्तव में क्या कर रहा है, या अगला बदलाव सुरक्षित है या नहीं? भले ही एजेंट आपके लिए काम कर रहा हो, उसे सही दिशा में ले जाने के लिए जिस सिस्टम को आप बना रहे हैं, उसकी कम-से-कम बुनियादी समझ होना ज़रूरी है.
इसीलिए हमने Cluedoc बनाया। Cluedoc एक Agent Skill है जो coding agent से इंसानों के लिए आसानी से पढ़े जा सकने वाले दस्तावेज़ लिखवाता है। Cluedoc के दस्तावेज़ पढ़े जाने के लिए बनाए जाते हैं। ये तकनीकी बारीकियों से अलग रहकर उच्च-स्तरीय अवधारणाओं पर ध्यान केंद्रित करते हैं.
Cluedoc सिस्टम को feature की एक tree के रूप में देखता है, और हर feature के लिए एक document (paper) लिखता है। दस्तावेज़ codebase के भीतर शुद्ध Markdown के रूप में मौजूद रहते हैं और work loop के अंदर हमेशा अपडेटेड रखे जाते हैं। किसी server की ज़रूरत नहीं, किसी database की भी ज़रूरत नहीं।
लिंक किया गया landing page खुद Cluedoc के बारे में लिखा गया एक Cluedoc document है। Flask, Cobra, Commander के लिए बनाए गए example documents भी हैं, उन्हें भी एक बार देखिए.
अभी कोई टिप्पणी नहीं है.