วิศวกรรมซอฟต์แวร์
สร้างทัวร์คลังโค้ดสำหรับวิศวกรใหม่
ทัวร์สำหรับผู้เริ่มต้นที่เริ่มจากเส้นทางที่รันได้ อธิบายขอบเขตและความเป็นเจ้าของคลังโค้ด และจัดแบบฝึกอ่านโค้ดที่ลึกขึ้นตามลำดับ
กระบวนการ
ทำตามลำดับนี้
- ระบุบทบาทของวิศวกรใหม่ ผลลัพธ์แรกที่มีประโยชน์ กรอบเวลา การแก้ไขของคลังโค้ด ข้อกำหนดในเครื่อง และคำถามที่การทัวร์ควรตอบ
- ตามรอยเส้นทางปกติที่ปลอดภัยหนึ่งเส้นทางตั้งแต่จุดเข้าจนถึงการทดสอบหรือผลงาน พร้อมบันทึกคำสั่ง ผลลัพธ์ที่คาด และการเปลี่ยนแปลงที่มีประโยชน์หน่วยเล็กที่สุด
- แผนที่ไดเรกทอรีหลัก ขอบเขตการบิลด์และการประกาศ ระบบข้อมูลและระบบภายนอก เจ้าของ เอกสาร และการตัดสินใจสำคัญ
- สร้างจุดหยุดแบบค่อยเป็นค่อยไป โดยแต่ละจุดมีคำถามอ่าน แบบฝึกหัดเล็ก สัญญาณการตรวจสอบ และจุดหยุดชัดเจนก่อนการใช้งานระบบผลิตหรือการเข้าถึงที่มีผลกระทบ
- เพิ่มคำศัพท์ ลิงก์ไปยังโค้ดและการตัดสินใจที่เชื่อถือได้ กับดักที่พบบ่อย ผู้ติดต่อสำหรับการยกระดับ และแนวทางสำหรับหลักฐานส่วนตัวหรือไม่เป็นสาธารณะ
- ให้เพื่อนร่วมทีมหรือการตรวจสอบด้วยตนเองจากสภาพแวดล้อมที่สะอาดช่วยตรวจทัวร์ แก้ขั้นตอนที่ไม่ชัด และบันทึกสิ่งที่ทดสอบไม่ได้
- เผยแพร่ทัวร์พร้อมเวอร์ชัน เจ้าของการอัปเดต หลักฐานของแต่ละเส้นทาง ข้อจำกัดที่ทราบ และความเสี่ยงที่ยังไม่ได้แก้ไขสำหรับผู้ดูแลในอนาคต
เตรียมสิ่งนี้
ข้อมูลที่แมวจะขอ
- บทบาทของวิศวกรใหม่และผลลัพธ์แรก
- คลังโค้ดและคำแนะนำการตั้งค่าในเครื่อง
- กรอบเวลาและข้อจำกัดการเรียนรู้
- เจ้าของและผู้ติดต่อสำหรับการยกระดับ
เราเตอร์ + playbook เดียว
จัดเส้นทางก่อน เลือกอันเดียว
Cat Paw โหลด playbook เดียวต่องาน ไม่ผสมหลายอัน เริ่มที่เราเตอร์นี้ เส้นทางที่เหลือเป็นตัวเลือกเฉพาะ workflow
- เราเตอร์:
codebase-knowledge-pack skills/codebase-knowledge-pack/codebase-onboarding-tour/SKILL.md
เส้นเขต
ขอบเขตเดินทางไปกับพรอมต์
- ก่อนเริ่ม ให้ตรวจสอบเครื่องมือ บัญชี สิทธิ์ และพื้นที่ทำงานจริง ห้ามอ้างว่ามีเครื่องมือ บัญชี แหล่งข้อมูล หรือความสามารถที่ไม่พร้อมใช้งาน
- ใช้ Latch/target-workspace สำหรับโค้ดส่วนตัว ผลงาน การตรวจสอบสด หรือข้อมูลที่ไม่เป็นสาธารณะ หากไม่มีสิทธิ์เข้าถึง ให้หยุดที่ขอบเขตและรายงานสิ่งกีดขัด แทนการเดา
- หยุดเพื่อขออนุมัติอย่างชัดเจนก่อนการดำเนินการภายนอกที่มีผลกระทบ แล้วส่งกลับหลักฐาน ความเสี่ยงที่ยังไม่ได้แก้ไข สมมติฐาน และการดำเนินการใดที่ยังรอการอนุมัติ
เสร็จหมายถึง
จุดจบที่ตรวจได้
ทัวร์ประจำการเข้าทำงานที่มีเวอร์ชันพาวิศวกรใหม่จากเส้นทางที่รันได้ซึ่งตรวจสอบแล้วไปสู่ความรู้ที่ลึกขึ้นเกี่ยวกับคลังโค้ด พร้อมบันทึกความเป็นเจ้าของ แบบฝึกหัด หลักฐาน และความเสี่ยงที่ยังไม่ได้แก้ไข
แหล่งที่มา
กระบวนการนี้มาจากไหน
- 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 และชุมชน ถ้ามี ให้ถือเป็นเรื่องเล่าจากผู้ปฏิบัติ ไม่ใช่ข้อเท็จจริงสากล
