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

ยินดีต้อนรับสู่คู่มือผู้ร่วมสร้างเอกสาร (Docs) docs.microsoft.com!

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

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

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

ข้อสำคัญ

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

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

การแก้ไขด่วนกับเอกสารที่มีอยู่แล้ว

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

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

    ตำแหน่งของลิงก์แก้ไข

    หากปุ่ม แก้ไข ไม่ปรากฏขึ้นหมายความว่าเนื้อหาไม่เป็นค่าเปิดเป็นการสนับสนุนสาธารณะ

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

    ตำแหน่งที่ตั้งของไอคอนรูปดินสอ

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

  4. เมื่อคุณเปลี่ยนแปลงสิ่งที่ต้องการแล้ว ให้เลื่อนไปด้านล่างของหน้า กรอกชื่อเรื่องและคำอธิบายสำหรับการเปลี่ยนแปลงของคุณ แล้วคลิก เสนอการเปลี่ยนแปลงไฟล์ ดังที่แสดงในรูปภาพต่อไปนี้:

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

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

    สร้างคำขอดึงข้อมูล

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

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

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

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

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

หมายเหตุ

เมื่อเปิดใช้งาน คุณสามารถแก้ไขบทความใน ภาษาใดก็ได้ และสิ่งต่อไปนี้จะเกิดขึ้นตามประเภทของการแก้ไข:

  1. การเปลี่ยนแปลงด้านภาษาทั้งหมดที่ได้รับอนุมัติจะช่วยปรับปรุงโปรแกรมการแปลด้วยเครื่องของเรา
  2. การแก้ไขทั้งหมดที่ปรับเปลี่ยนเนื้อหาของบทความอย่างมากจะได้รับการจัดการภายในเพื่อส่งการเปลี่ยนแปลงไปยังบทความเดียวกันในภาษาอังกฤษเพื่อแปลเป็นภาษาต่างๆ ทุกภาษา ถ้าได้รับอนุมัติ การปรับปรุงที่แนะนำของคุณจะไม่เพียงแต่ส่งผลในแง่บวกต่อบทความในภาษาของคุณเองเท่านั้น แต่ในภาษาที่มีอยู่ทั้งหมดด้วย

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

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

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

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

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

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

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

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