สร้างเอกสารโครงการโดยใช้ GitHub Copilot

เสร็จสมบูรณ์เมื่อ

เอกสารโครงการอธิบายวัตถุประสงค์ เป้าหมาย และความต้องการของโครงการ ในการสร้างเอกสารโครงการ คุณต้องทําความเข้าใจโครงสร้างโครงการ ส่วนประกอบ และวิธีการที่คอมโพเนนต์โต้ตอบซึ่งกันและกัน

มุมมองแชทของ GitHub Copilot เป็นเครื่องมือที่เหมาะสําหรับการสร้างเอกสารโครงการ เนื่องจากสามารถวิเคราะห์โครงสร้างโครงการทั้งหมดและให้ภาพรวมระดับสูงของโครงการ มุมมองแชทยังสามารถใช้เพื่อสร้างเอกสารประเภทเฉพาะเช่นไฟล์ README, การอ้างอิง API และเอกสารที่เกี่ยวข้องกับโครงการอื่น ๆ

คุณสามารถใช้โหมดมุมมองแชทแต่ละโหมด (ถาม ตัวแทน หรือ วางแผน) เพื่อสร้างเอกสารประกอบโครงการ แต่ละโหมดมีจุดแข็งและจุดอ่อนของตัวเอง ข้อมูลจําเพาะของโครงการและข้อจํากัดอื่น ๆ จะมีผลต่อโหมดที่ควรใช้

สําคัญ

เมื่อคุณใช้มุมมอง แชท ในโหมดตัวแทน แต่ละพร้อมท์ที่คุณป้อนจะนับเป็นคําขอพรีเมียมหนึ่งรายการ คูณด้วยตัวคูณของโมเดล GitHub Copilot อาจดําเนินการติดตามผลหลายอย่างเพื่อทํางานให้เสร็จสมบูรณ์ แต่การดําเนินการติดตามผลเหล่านี้จะไม่นับรวมในการใช้คําขอพรีเมียมของคุณ ระบบจะเรียกเก็บเงินเฉพาะข้อความแจ้งที่คุณป้อนเท่านั้น คําขอพรีเมียมทั้งหมดที่ใช้ขึ้นอยู่กับจํานวนข้อความแจ้งที่คุณป้อนและรุ่นที่เลือก

สร้างข้อกําหนดของเอกสารโครงการ

ประเภทเอกสารและข้อกําหนดของเนื้อหาขึ้นอยู่กับโครงการผู้บริโภคที่ตั้งใจและมาตรฐานที่นํามาใช้โดยองค์กร

ตัวอย่างเช่น README.md อาจรวมถึงส่วนต่อไปนี้:

• ชื่อโครงการ: ชื่อของโครงการของคุณ
• คําอธิบาย: ภาพรวมโดยย่อของสิ่งที่โครงการทําและสาเหตุ
• สารบัญ: ไม่บังคับ แต่มีประโยชน์สําหรับ READMEs ที่ยาวขึ้น
• การติดตั้ง: คําแนะนําเกี่ยวกับวิธีการติดตั้งและตั้งค่าโครงการ
• การใช้งาน: ตัวอย่างของวิธีการใช้โครงการ รวมถึงส่วนย่อยของโค้ดหรือสกรีนช็อต
• ฟีเจอร์: รายการคุณลักษณะหลักหรือฟังก์ชันการทํางาน
• การกําหนดค่า: รายละเอียดเกี่ยวกับตัวเลือกการกําหนดค่าหรือตัวแปรสภาพแวดล้อมต่างๆ
• ร่วมสร้าง: แนวทางการร่วมสร้างโครงการ
• สิทธิ์การใช้งาน: สิทธิ์การใช้งานใดๆ ที่ใช้โดยโครงการแบบแจกจ่าย
• เครดิตและการยอมรับ: การรับรู้ของผู้สนับสนุน ไลบรารี หรือทรัพยากรที่ใช้
• ติดต่อ: วิธีติดต่อผู้ดูแลหรือทีมโครงการ
• บันทึกการเปลี่ยนแปลง: ประวัติของการเปลี่ยนแปลงและการอัปเดต (บางครั้งเชื่อมโยงกับไฟล์แยกต่างหาก)

GitHub Copilot Chat สามารถช่วยคุณสร้างเอกสารโครงการที่ตรงกับความต้องการเฉพาะของโครงการและผู้มีส่วนได้ส่วนเสีย

ใช้โหมด สอบถามตัวแทน เพื่อสร้างเอกสารโครงการ

โหมด สอบถามตัวแทน สามารถใช้เพื่อวิเคราะห์พื้นที่ทํางาน แล้วสร้างเอกสารประกอบ

ใช้กระบวนการต่อไปนี้เพื่อสร้างเอกสารโครงการโดยใช้โหมดถามตัวแทน:

1. ระบุข้อกําหนดของเอกสารประกอบและแหล่งข้อมูลสนับสนุน

   • ระบุข้อกําหนดเอกสารสําหรับโครงการของคุณ ระบุชนิดของเอกสารและส่วนเอกสารที่จําเป็น

   • ระบุแหล่งข้อมูลที่จําเป็นในการสร้างเอกสาร พื้นที่ทํางานโค้ดของคุณอาจเป็นทรัพยากรเดียวที่จําเป็น อย่างไรก็ตาม คุณอาจจําเป็นต้องเพิ่มบริบทลงในแชทสําหรับส่วนเช่น "การสนับสนุน" "เครดิต" และ "ผู้ติดต่อ"

2. เปิดมุมมองแชทและเริ่มเซสชันแชทใหม่โดยใช้โหมดถามเจ้าหน้าที่

3. เพิ่มบริบทไปยังเซสชันการสนทนา

   • คุณสามารถเพิ่มบริบทให้กับเซสชันการแชทได้โดยการลากและวางไฟล์จากมุมมอง EXPLORER ของ Visual Studio Code ลงในมุมมองการแชท คุณยังสามารถใช้ปุ่มแนบ บริบท (ไอคอนคลิปหนีบกระดาษ) ได้อีกด้วย
   • คุณสามารถเปิดไฟล์ภายนอกในตัวแก้ไขโค้ดเพื่อรวมทรัพยากรที่ไม่ใช่ส่วนหนึ่งของพื้นที่ทํางาน และใช้เพื่อให้บริบทเพิ่มเติม ตัวอย่างเช่น คุณสามารถเปิดไฟล์ Markdown ที่มีแนวทางของผู้สนับสนุนหรือข้อมูลติดต่อ แล้วใช้ปุ่ม แนบบริบท เพื่อเพิ่มลงในบริบทของมุมมองแชท

4. ป้อนชุดของข้อความพร้อมต์ที่ตรวจสอบข้อกําหนดของเอกสารของคุณ

   คุณสามารถใช้โหมด สอบถามตัวแทน เพื่อวิเคราะห์พื้นที่ทํางานและสร้างประวัติเซสชันการแชทที่รองรับข้อกําหนดด้านเอกสารของคุณ การอธิบายเป้าหมายของคุณสามารถช่วยสร้างบริบทสําหรับเซสชันการสนทนา การถามคําถามที่ตรงกับความต้องการของคุณจะช่วยให้ GitHub Copilot ระบุข้อมูลที่จําเป็นในการสร้างเอกสารประกอบ

   รีเฟรชบริบทที่เพิ่มตามความจําเป็น

5. ป้อนพร้อมท์ที่ขอเอกสารโครงการที่แนะนํา โดยแสดงรายการส่วนที่จําเป็นที่คุณระบุไว้ในขั้นตอนแรก

   ตัวอย่างเช่น: "@workspace /explain I need help creating a README file that can be used in the GitHub repository for this workspace. The file should be formatted as markdown. The README file needs to include the following sections: Project Title, Description, Table of Contents, Installation, Usage, Features, Configuration, and License."

6. ตรวจทานเอกสารประกอบโครงการที่แนะนําและปรับปรุงผลลัพธ์โดยใช้พร้อมท์ใหม่หากจําเป็น

7. ย้ายเอกสารโครงการที่แนะนําลงในไฟล์เอกสารโครงการ

   ตัวอย่างเช่น สร้างไฟล์ README.md ที่รากของพื้นที่ทํางาน และแทรกเนื้อหาที่แนะนําลงในไฟล์

   คุณสามารถใช้โหมด สอบถามตัวแทน เพื่อแนะนําการอัปเดตสําหรับส่วนเฉพาะของโครงการของคุณหลังจากสร้างเอกสาร หรือใช้เครื่องมือ GitHub Copilot อื่นๆ เพื่อช่วยในการอัปเดต

ใช้โหมด แผน เพื่อสร้างเอกสารโครงการ

โหมดแผนเหมาะที่สุดสําหรับการสร้างแผนการดําเนินงานโดยละเอียดก่อนสร้างเอกสารโครงการ โหมด แผน จะวิเคราะห์ฐานรหัส ระบุข้อกําหนดด้านเอกสาร และสร้างแผนทีละขั้นตอน เมื่อแผนได้รับการอนุมัติแล้ว คุณสามารถส่งต่อไปยังโหมดตัวแทนเพื่อดําเนินการได้

ใช้กระบวนการต่อไปนี้เพื่อสร้างเอกสารโครงการ เช่น ไฟล์ README.md โดยใช้โหมดแผน:

1. ระบุข้อกําหนดของเอกสารประกอบและแหล่งข้อมูลสนับสนุน

2. เปิดมุมมองแชทและเริ่มเซสชันแชทใหม่โดยใช้โหมดแผน

3. ป้อนข้อความแจ้งที่อธิบายงานเอกสารของคุณ

   ตัวอย่างเช่น: "ฉันต้องการสร้างไฟล์ README และเอกสารประกอบสําหรับโครงการนี้ README ควรประกอบด้วย: ชื่อโครงการ คําอธิบาย สารบัญ การติดตั้ง การใช้งาน คุณลักษณะ การกําหนดค่า และใบอนุญาต"

4. ตรวจสอบแผนการใช้งาน

   หลังจากนั้นสักครู่ ตัวแทนแผนจะส่งออกแผนในมุมมองแชท แผนนี้ให้ข้อมูลสรุประดับสูงและรายละเอียดของขั้นตอน รวมถึงคําถามที่เปิดอยู่เพื่อขอคําชี้แจง คุณสามารถทําซ้ําได้หลายครั้งเพื่อชี้แจงข้อกําหนด ปรับขอบเขต หรือตอบคําถาม

5. เมื่อแผนเสร็จสมบูรณ์ ให้เลือก เริ่มการใช้งาน เพื่อส่งต่อแผนไปยังโหมดตัวแทน หรือเลือก เปิดในตัวแก้ไข เพื่อบันทึกแผนเป็นไฟล์ Markdown เพื่อใช้ในภายหลัง

   เมื่อคุณเลือก เริ่มการใช้งาน GitHub Copilot จะเปลี่ยนเป็นโหมดตัวแทนและเริ่มใช้เอกสารประกอบตามแผนที่อนุมัติ ตรวจสอบไฟล์เอกสารที่สร้างขึ้นและยอมรับหรือละทิ้งการเปลี่ยนแปลง

ใช้โหมดตัวแทนในการสร้างเอกสารโครงการ

โหมดตัวแทนเหมาะที่สุดสําหรับการสร้างเอกสารโครงการที่จําเป็นต้องมีความเข้าใจในเชิงลึกเกี่ยวกับโครงการ โหมดตัวแทนวิเคราะห์โครงสร้างโครงการทั้งหมดก่อนที่จะสร้างเอกสารโครงการ โดยการรวบรวมข้อมูลจากหลายไฟล์และโฟลเดอร์ โหมดตัวแทนสามารถอธิบายความสัมพันธ์ที่ซับซ้อน และรวมลิงก์ระหว่างเอกสาร

ใช้กระบวนการต่อไปนี้เพื่อสร้างเอกสารโครงการ เช่น ไฟล์ README.md โดยใช้โหมดตัวแทน:

1. ระบุข้อกําหนดของเอกสารประกอบและแหล่งข้อมูลสนับสนุน

2. เปิดมุมมองแชทและเริ่มเซสชันการสนทนาใหม่โดยใช้โหมดตัวแทน

3. เพิ่มบริบทไปยังเซสชันการสนทนา

   ผู้เข้าร่วมในแชทไม่พร้อมใช้งานในโหมดตัวแทน ดังนั้นคุณไม่สามารถระบุ @workspace ให้เป็นส่วนหนึ่งของพร้อมท์ของคุณได้ อย่างไรก็ตาม คุณสามารถเพิ่มบริบทไปยังเซสชันการสนทนาโดยใช้ #codebase และ โดยการเพิ่มไฟล์และโฟลเดอร์ของพื้นที่ทํางานไปยังบริบทการสนทนา ไฟล์ภายนอกสามารถเปิดได้ใน Visual Studio Code แล้วเพิ่มลงในบริบทการแชทโดยใช้ปุ่ม แนบบริบท

4. ป้อนข้อความแจ้งเตือนเพื่อสร้างเอกสารโครงการที่ต้องการ

   ตัวอย่างเช่น: "สร้างคอลเลกชันของไฟล์เอกสารโครงการ สร้างหรืออัปเดตไฟล์ README.md พื้นที่ทํางานสําหรับที่เก็บนี้ สร้างหรืออัปเดตไฟล์ UsageExamples.md สร้างหรืออัปเดตไฟล์ ChangeLog.md รวมลิงก์ระหว่างไฟล์เอกสาร คลาสและวิธีการอ้างอิงโยง และตรวจสอบให้แน่ใจว่าในเอกสารมีความสอดคล้องกัน"

5. ตรวจทานแฟ้มเอกสาร แล้วบันทึกหรือละทิ้งการปรับปรุง

   อัปเดตไฟล์โดยใช้พร้อมท์ให้แก้ไขหรือปรับปรุงส่วนที่เฉพาะเจาะจงถ้าจําเป็น

ความสามารถของโหมดตัวแทน

มีงานเอกสารหลายอย่างที่โหมดตัวแทนเป็นตัวเลือกที่ดีที่สุด

1. การสร้างเอกสารหลายไฟล์และข้ามไฟล์

   • โหมดตัวแทนสามารถวิเคราะห์โครงสร้างโครงการทั้งหมด รวบรวมข้อมูลจากหลายไฟล์และโฟลเดอร์ และสร้างเอกสารที่เชื่อมโยงและสรุปเนื้อหาทั่วทั้งโค๊ดเบส ตัวอย่างเช่น การสร้างการอ้างอิง API แบบเต็มหรือ README ที่อธิบายส่วนประกอบหลักทั้งหมด

2. การวิเคราะห์และการสรุปโครงการอัตโนมัติ

   • โหมดตัวแทนสามารถทํางานเช่นการสรุปสถาปัตยกรรม ระบุคลาส/บริการหลัก และสร้างไดอะแกรมหรือตารางที่ต้องการทําความเข้าใจความสัมพันธ์ระหว่างไฟล์และคอมโพเนนต์

3. การสร้างเนื้อหาแบบไดนามิก (ตัวอย่างเช่น ตัวอย่างการใช้งาน ตารางคลาส)

   • โหมดตัวแทนสามารถสแกนโครงการเพื่อสร้างตัวอย่างการใช้งาน ตารางความรับผิดชอบของคลาส หรือรายการของ API สาธารณะได้

4. งานจัดทําเอกสารชุดงาน

   • โหมดตัวแทนสามารถดําเนินการลําดับของงานเอกสาร (ตัวอย่างเช่น อัปเดต README, สร้าง CONTRIBUTING.md, สร้างเอกสาร API, อัปเดตบันทึกการเปลี่ยนแปลง) ในเวิร์กโฟลว์เดียว

5. การเชื่อมโยงและการนําทางอัจฉริยะ

   • โหมดตัวแทนสามารถสร้างลิงก์ระหว่างไฟล์เอกสาร คลาสและวิธีการอ้างอิงแบบไขว้ และรับประกันความสอดคล้องระหว่างเอกสาร

โหมดตัวแทนเหมาะสําหรับงานเอกสารทั้งโครงการ หลายไฟล์ และเอกสารบริบทที่จําเป็นต้องมีการวิเคราะห์ การสังเคราะห์ และการประสานงาน

สรุป

GitHub Copilot สามารถช่วยคุณสร้างเอกสารโครงการที่ตรงกับความต้องการเฉพาะของโครงการและผู้มีส่วนได้ส่วนเสีย มุมมอง แชท สามารถใช้เพื่อสร้างเอกสารโครงการในโหมดที่แตกต่างกันสามโหมด: ถาม ตัวแทน และ วางแผน แต่ละโหมดมีจุดแข็งและจุดอ่อนของตัวเองและโหมดที่ดีที่สุดที่จะใช้ขึ้นอยู่กับงานเฉพาะที่อยู่ในมือ โหมดถามตัวแทนเหมาะที่สุดสําหรับการถามคําถามเกี่ยวกับฐานรหัสหรือแนวคิดด้านเทคโนโลยีของคุณ โหมดตัวแทนเหมาะที่สุดสําหรับการสร้างเอกสารโครงการที่ต้องการความเข้าใจในเชิงลึกเกี่ยวกับโครงการ โหมด แผน เหมาะที่สุดสําหรับการสร้างแผนการใช้งานโดยละเอียดก่อนที่จะสร้างเอกสาร ซึ่งสามารถส่งต่อไปยังโหมดตัวแทนเพื่อดําเนินการได้