วิศวกรรมซอฟต์แวร์
สร้างกราฟสถาปัตยกรรมคลังโค้ด
แผนที่คลังโค้ดแบบชั้นที่เชื่อมจุดเข้า โมดูล ที่เก็บข้อมูล ระบบภายนอก และความเป็นเจ้าของ ช่วยให้วิศวกรเดินทางผลกระทบของการเปลี่ยนโดยไม่อ้างว่ากราฟสมบูรณ์
กระบวนการ
ทำตามลำดับนี้
- กำหนดการแก้ไขของคลังโค้ด ภาษา จุดประสงค์ของกราฟ ระดับรายละเอียดที่ต้องการ และคำถามที่กราฟต้องช่วยตอบ
- ทำบัญชีจุดเข้า ไฟล์บิลด์และการประกาศ อุปกรณ์ บริการ ที่เก็บข้อมูล คิว การรวมระบบภายนอก และพื้นที่ที่สร้างหรือรวมจากภายนอก
- ตามรอย import การเรียก เหตุการณ์ การตั้งค่า และการไหลของข้อมูลด้วยหลักฐานโค้ดและคลังโค้ดที่มี พร้อมบันทึกเส้นทางที่แน่นอนและระดับความมั่นใจ
- จัดโหนดและความสัมพันธ์เป็นชั้นระบบ คอนเทนเนอร์ คอมโพเนนต์ และโค้ดที่มีประโยชน์ โดยไม่ยุบความรับผิดชอบที่ต่างกันไว้ในกล่องเดียว
- เพิ่มเจ้าของ การทดสอบ เอกสาร สิ่งที่ต้องใช้ขณะรัน ป้ายระบบภายนอก และทำเครื่องหมายความสัมพันธ์ที่อนุมาน ล้าสมัย หรือหาไม่ได้อย่างชัดเจน
- ตรวจสอบกราฟกับเส้นทาง บิลด์ และการทดสอบตัวแทน จากนั้นบันทึกการเปลี่ยนแปลง ขอบที่หายไป และเจ้าของถัดไปของแต่ละการแก้ไข
- เผยแพร่กราฟหรือแผนภาพที่มีเวอร์ชัน พร้อมคำอธิบาย ลิงก์หลักฐาน ตัวกระตุ้นการอัปเดต ขอบเขตการครอบคลุม และความเสี่ยงที่ยังไม่ได้แก้ไข แทนการเรียกว่าเป็นแผนที่สมบูรณ์โดยไม่มีเงื่อนไข
เตรียมสิ่งนี้
ข้อมูลที่แมวจะขอ
- คลังโค้ดและการแก้ไข
- คำถามสถาปัตยกรรมและขอบเขต
- การเข้าถึงโค้ดและประวัติที่มี
- ผู้รับที่ต้องการและเจ้าของการอัปเดต
เราเตอร์ + playbook เดียว
จัดเส้นทางก่อน เลือกอันเดียว
Cat Paw โหลด playbook เดียวต่องาน ไม่ผสมหลายอัน เริ่มที่เราเตอร์นี้ เส้นทางที่เหลือเป็นตัวเลือกเฉพาะ workflow
- เราเตอร์:
code-graph-pack skills/code-graph-pack/repository-architecture-graph/SKILL.md
เส้นเขต
ขอบเขตเดินทางไปกับพรอมต์
- ก่อนเริ่ม ให้ตรวจสอบเครื่องมือ บัญชี สิทธิ์ และพื้นที่ทำงานจริง ห้ามอ้างว่ามีเครื่องมือ บัญชี แหล่งข้อมูล หรือความสามารถที่ไม่พร้อมใช้งาน
- ใช้ Latch/target-workspace สำหรับโค้ดส่วนตัว ผลงาน การตรวจสอบสด หรือข้อมูลที่ไม่เป็นสาธารณะ หากไม่มีสิทธิ์เข้าถึง ให้หยุดที่ขอบเขตและรายงานสิ่งกีดขัด แทนการเดา
- หยุดเพื่อขออนุมัติอย่างชัดเจนก่อนการดำเนินการภายนอกที่มีผลกระทบ แล้วส่งกลับหลักฐาน ความเสี่ยงที่ยังไม่ได้แก้ไข สมมติฐาน และการดำเนินการใดที่ยังรอการอนุมัติ
เสร็จหมายถึง
จุดจบที่ตรวจได้
กราฟสถาปัตยกรรมคลังโค้ดที่มีเวอร์ชันเชื่อมคอมโพเนนต์และการไหลที่ตรวจสอบแล้วกับหลักฐานโค้ด เจ้าของ การทดสอบ ความมั่นใจ ขอบเขตการครอบคลุม และความเสี่ยงที่ยังไม่ได้แก้ไข
แหล่งที่มา
กระบวนการนี้มาจากไหน
- github.com/Graphify-Labs/graphify/tree/4c735618f3d56fd622c2049771584621c31ba9ff/
- c4model.com/
- docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
แหล่งที่มาตั้งรูปแบบของ workflow โพสต์ Reddit และชุมชน ถ้ามี ให้ถือเป็นเรื่องเล่าจากผู้ปฏิบัติ ไม่ใช่ข้อเท็จจริงสากล