सॉफ्टवेयर इंजीनियरिंग
नए इंजीनियर के लिए codebase tour बनाएँ
नए इंजीनियर के लिए परिचयात्मक tour जो चलाने योग्य path से शुरू होता है, repository की सीमाएँ और ownership समझाता है और क्रमिक code-reading अभ्यास निर्धारित करता है।
प्रक्रिया
इस क्रम में करो।
- नए इंजीनियर की भूमिका, पहला उपयोगी परिणाम, समय-सीमा, रिपॉज़िटरी संशोधन, स्थानीय पूर्व-शर्तें और tour के उत्तर देने वाले प्रश्न तय करें।
- प्रवेश-बिंदु से किसी परीक्षण या artifact तक एक सुरक्षित सामान्य-पथ ट्रेस करें, कमांड, अपेक्षित आउटपुट और सबसे छोटा उपयोगी बदलाव दर्ज करें।
- प्रमुख निर्देशिकाएँ, build और deployment सीमाएँ, data और external systems, स्वामी, दस्तावेज़ और प्रमुख निर्णयों का नक्शा बनाएँ।
- क्रमिक पड़ाव बनाएँ, जिनमें पढ़ने का प्रश्न, छोटा अभ्यास, सत्यापन-संकेत और उत्पाद या परिणामी पहुँच से पहले स्पष्ट रुकावट हो।
- शब्दावली, प्राधिकृत code और decision लिंक, सामान्य गलतियाँ, escalation संपर्क और निजी या गैर-सार्वजनिक प्रमाण के लिए मार्गदर्शिका जोड़ें।
- साथी या साफ वातावरण से self-check की मदद से tour जाँचें, अस्पष्ट चरण सुधारें और जो परीक्षित नहीं हो सका उसे दर्ज करें।
- संस्करण, update owner, हर path का प्रमाण, ज्ञात सीमाएँ और भविष्य के maintainers के लिए अनसुलझे जोखिम सहित tour प्रकाशित करें।
यह लाओ
इनपुट जो बिल्ली मांगेगी।
- नए इंजीनियर की भूमिका और पहला परिणाम
- रिपॉज़िटरी और स्थानीय सेटअप निर्देश
- समय-सीमा और सीखने की सीमाएँ
- स्वामी और escalation संपर्क
राउटर + एक playbook
पहले रूट करो। एक चुनो।
Cat Paw हर काम पर एक playbook खोलता है, कई को मिलाता नहीं। इस राउटर से शुरू करो; बाकी रास्ते इसी workflow के उम्मीदवार हैं।
- राउटर:
codebase-knowledge-pack skills/codebase-knowledge-pack/codebase-onboarding-tour/SKILL.md
सीमाएँ
सीमाएँ प्रॉम्प्ट के साथ चलती हैं।
- शुरू करने से पहले वास्तविक टूल, खाते, अनुमतियों और वर्कस्पेस की जाँच करें; कभी न कहें कि अनुपलब्ध टूल, खाता, स्रोत या क्षमता मौजूद है।
- निजी कोड, कलाकृत, लाइव जाँच या गैर-सार्वजनिक डेटा के लिए Latch/target-workspace का उपयोग करें; यह पहुँच उपलब्ध न हो तो अनुमान के बजाय सीमा पर रुककर अड़चन बताएँ।
- महत्वपूर्ण बाहरी कार्रवाई से पहले स्पष्ट स्वीकृति के लिए रुकें; प्रमाण, अनसुलझे जोखिम, मान्यताएँ और स्वीकृति की प्रतीक्षा में कोई भी कार्रवाई लौटाएँ।
पूरा मतलब
एक जाँचने लायक अंत।
संस्करणित onboarding tour नए इंजीनियर को सत्यापित चलने योग्य path से गहरे repository ज्ञान तक ले जाता है और ownership, exercises, प्रमाण व अनसुलझे जोखिम दर्ज करता है।
स्रोत
यह प्रक्रिया कहाँ से आई।
- github.com/Egonex-AI/Understand-Anything/tree/6df3065f1d8ddc2ce3615314d1d493f36d6b1c80/
- c4model.com/
- docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
स्रोत workflow का पैटर्न तय करते हैं। Reddit और कम्युनिटी पोस्ट, जहाँ हैं, अभ्यास की कहानी हैं — सार्वभौमिक तथ्य नहीं।