ภาพรวมคู่มือผู้ร่วมสร้าง Microsoft Docs

ยินดีต้อนรับสู่คู่มือผู้ร่วมสร้างเอกสาร Microsoft!

การแบ่งปันความเชี่ยวชาญของคุณกับผู้อื่นใน Microsoft Learn ช่วยให้ทุกคนบรรลุผลสัมฤทธิ์มากขึ้น ใช้ข้อมูลในคู่มือนี้เพื่อเผยแพร่บทความใหม่ไปยัง Microsoft Learn หรือทําการอัปเดตบทความที่เผยแพร่ที่มีอยู่

การแชร์ความเชี่ยวชาญของคุณกับผู้อื่นใน Learn ช่วยให้ทุกคนบรรลุผลมากขึ้น ใช้ข้อมูลในคู่มือนี้เพื่อเผยแพร่บทความใหม่เพื่อ learn.microsoft.com หรือทําการอัปเดตบทความที่เผยแพร่แล้ว

ชุดคู่มือหลายชุดของ Microsoft เป็นโอเพนซอร์สและโฮสต์อยู่บน GitHub ชุดเอกสารบางชุดไม่ได้โอเพนซอร์ส (Open Source)ทั้งหมด แต่เอกสารหลายชุดมีที่เก็บที่เชื่อมต่อกับสาธารณะ ซึ่งคุณสามารถแนะนําการเปลี่ยนแปลงผ่านคําขอดึงข้อมูล (PR) วิธีการแบบโอเพนซอร์สนี้เพิ่มความคล่องตัวและปรับปรุงการสื่อสารระหว่างวิศวกรผลิตภัณฑ์ ทีมเนื้อหา และลูกค้า และมีข้อดีอื่น ๆ:

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

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

ข้อสำคัญ

ที่เก็บทั้งหมดที่เผยแพร่ไปยัง Microsoft Learn ได้นํา แนวทางปฏิบัติของ Microsoft Open Source หรือ แนวทางปฏิบัติของ .NET Foundation มาใช้ สำหรับข้อมูลเพิ่มเติม ดูคำถามที่ถามบ่อยเกี่ยวกับแนวทางปฏิบัติ ติดต่อ opencode@microsoft.com หรือ conduct@dotnetfoundation.org เมื่อมีคําถามหรือข้อคิดเห็นใดๆ

การแก้ไขหรือการชี้แจงเล็กน้อยกับเอกสารประกอบและตัวอย่างโค้ดในที่เก็บสาธารณะครอบคลุมโดยข้อกําหนดการใช้งาน learn.microsoft.com การเปลี่ยนแปลงใหม่หรือที่สําคัญจะสร้างข้อคิดเห็นใน PR ขอให้คุณส่ง ข้อตกลงสิทธิ์การใช้งานผลงาน (CLA) แบบออนไลน์ ถ้าคุณไม่ใช่พนักงานของ Microsoft เราต้องการให้คุณกรอกแบบฟอร์มออนไลน์ให้เสร็จสิ้นก่อนที่เราจะสามารถตรวจทานหรือยอมรับ PR ของคุณได้

การแก้ไขด่วนในเอกสาร

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

  1. คุณสามารถแก้ไขเนื้อหาใน บาง หน้า Docs ได้โดยตรงในเบราว์เซอร์ หากคุณต้องการแก้ไข ให้มองหาปุ่ม แก้ไข ดังปุ่มที่แสดงด้านล่าง การเลือกปุ่ม แก้ไข (หรือภาษาท้องถิ่นที่เทียบเท่า) จะนําคุณไปยังไฟล์ต้นฉบับใน GitHub

    ตําแหน่งที่ตั้งของลิงก์แก้ไขบทความ

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

  2. เลือกไอคอนดินสอเพื่อแก้ไขบทความ ถ้าไอคอนดินสอเป็นสีเทา คุณต้องลงชื่อเข้าใช้บัญชี GitHub ของคุณ หรือสร้างบัญชีใหม่ก่อน

    ตําแหน่งที่ตั้งของไอคอนสําเนาและแก้ไขดินสอ

  3. แก้ไขไฟล์ในตัวแก้ไขเว็บ เลือกแท็บ แสดงตัวอย่าง เพื่อตรวจสอบการจัดรูปแบบการเปลี่ยนแปลงของคุณ

  4. เมื่อคุณแก้ไขเสร็จแล้ว ให้เลื่อนไปที่ด้านล่างของหน้า ในพื้นที่ เสนอการเปลี่ยนแปลง ให้ใส่ชื่อเรื่องและเลือกคําอธิบายสําหรับการเปลี่ยนแปลงของคุณ ชื่อเรื่องจะเป็นบรรทัดแรกของข้อความที่ยอมรับ เลือก เสนอการเปลี่ยนแปลง เพื่อบันทึกการเปลี่ยนแปลงของคุณ:

    เสนอและยอมรับการเปลี่ยนแปลงไฟล์

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

    เปรียบเทียบการเปลี่ยนแปลงและสร้างคําขอดึงข้อมูล

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

  6. แค่นี้เอง! สมาชิกทีมเนื้อหาจะตรวจสอบ PR ของคุณและผสานรวมเมื่อมีการอนุมัติ คุณอาจได้รับคําติชมเมื่อร้องขอการเปลี่ยนแปลง

UI การแก้ไขของ GitHub จะตอบสนองต่อสิทธิ์ในที่เก็บของคุณ รูปภาพก่อนหน้านี้มีไว้สําหรับผู้สนับสนุนที่ไม่มีสิทธิ์เขียนในที่เก็บเป้าหมาย GitHub จะสร้างสำเนาของที่เก็บเป้าหมายในบัญชีของคุณโดยอัตโนมัติ ชื่อส่วนแบ่งที่สร้างขึ้นใหม่มีฟอร์ม GitHubUsername/RepositoryName ตามค่าเริ่มต้น ถ้าคุณมีการเข้าถึงเพื่อเขียนในที่เก็บเป้าหมาย เช่น สําเนาของคุณ GitHub จะสร้างสาขาใหม่ในที่เก็บเป้าหมาย ชื่อสาขาจะมีฟอร์มเริ่มต้น patch-nโดยใช้ตัวระบุตัวเลขสําหรับสาขาที่แก้ไข

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

ประสบการณ์การแก้ไขในเบราว์เซอร์จะดีที่สุดสำหรับการเปลี่ยนแปลงเล็กน้อยที่ไม่บ่อยครั้ง ถ้าคุณร่วมสร้างข้อมูลจำนวนมาก หรือใช้ฟีเจอร์ Git ขั้นสูง (เช่น การจัดการสาขา หรือการแก้ความขัดแย้งของการผสานขั้นสูง) คุณต้องทำสำเนาที่เก็บและทำงานในเครื่อง

หมายเหตุ

เอกสารที่แปลเป็นภาษาท้องถิ่นส่วนใหญ่ไม่มีความสามารถในการแก้ไขหรือให้คําติชมผ่าน GitHub หากต้องการให้คําติชมเกี่ยวกับเนื้อหาที่แปลเป็นภาษาท้องถิ่น ให้ใช้เทมเพลตอีเมลที่มีอยู่ใน aka.ms/DocSiteLocFeedback

รีวิว PR แบบเปิด

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

สร้างประเด็นด้านคุณภาพ

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

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

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

มีส่วนร่วมมากขึ้น

หัวข้ออื่นในคู่มือนี้ช่วยให้คุณเริ่มต้นมีส่วนร่วมอย่างมีประสิทธิภาพกับ Microsoft Learn พวกเขาอธิบายการทํางานกับที่เก็บ GitHub เครื่องมือ Markdown และส่วนขยายที่ใช้ในเนื้อหา Microsoft Learn