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

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

ชุดคู่มือหลายชุดของ Microsoft เป็นโอเพนซอร์สและโฮสต์อยู่บน GitHubSeveral of the Microsoft documentation sets are open source and hosted on GitHub. ชุดเอกสารบางชุดไม่ได้เป็นโอเพนซอร์สโดยสมบูรณ์ แต่เอกสารหลายชุดก็มีที่เก็บที่ซึ่งคุณสามารถทำการเปลี่ยนแปลงที่แนะนำผ่านคำขอดึงข้อมูลNot all document sets are completely open source but many have public-facing repos where you can make suggested changes via pull requests. วิธีการแบบโอเพนซอร์สนี้เพิ่มความคล่องตัวและปรับปรุงการสื่อสารระหว่างวิศวกรผลิตภัณฑ์ ทีมเนื้อหา และลูกค้าและมีข้อได้เปรียบอื่น ๆ:This open source approach streamlines and improves communication between product engineers, content teams, and customers, and has other advantages:

  • ที่เก็บโอเพนซอร์ส_วางแผนแบบเปิด_เพื่อรับคำติชมว่าเอกสารใดเป็นที่ต้องการที่สุดOpen source repos plan in the open to get feedback on what docs are most needed.
  • ที่เก็บโอเพนซอร์ส_รีวิวแบบเปิด_เพื่อเผยแพร่เนื้อหาที่มีประโยชน์ที่สุดในการเผยแพร่ครั้งแรกของเราOpen source repos review in the open to publish the most helpful content on our first release.
  • ที่เก็บโอเพนซอร์ส_อัปเดตแบบเปิด_เพื่อทำให้การปรับปรุงเนื้อหาอยู่ตลอดเวลาเป็นเรื่องง่ายยิ่งขึ้นOpen source repos update in the open to make it easier to continuously improve the content.

ประสบการณ์ของผู้ใช้ใน docs.microsoft.com รวมเวิร์กโฟลว์ GitHub ไว้โดยตรงเพื่อทำให้ง่ายยิ่งขึ้นไปอีกThe user experience on docs.microsoft.com integrates GitHub workflows directly to make it even easier. เริ่มต้นโดยแก้ไขเอกสารที่คุณกำลังดูอยู่Start by editing the document you are viewing. หรือช่วยเหลือโดยรีวิวหัวข้อใหม่ หรือสร้างประเด็นด้านคุณภาพOr, help by reviewing new topics, or create quality issues.

ข้อสำคัญ

ที่เก็บทั้งหมดที่เผยแพร่ไปยัง docs.microsoft.com ได้นำ แนวทางปฏิบัติของ Microsoft Open Source หรือ แนวทางปฏิบัติของ .NET Foundation มาใช้All repositories that publish to docs.microsoft.com have adopted the Microsoft Open Source Code of Conduct or the .NET Foundation Code of Conduct. สำหรับข้อมูลเพิ่มเติม ดูคำถามที่ถามบ่อยเกี่ยวกับแนวทางปฏิบัติFor more information, see the Code of Conduct FAQ. หรือติดต่อopencode@microsoft.com หรือ conduct@dotnetfoundation.orgเมื่อมีคำถามหรือข้อคิดเห็นใดๆOr contact opencode@microsoft.com, or conduct@dotnetfoundation.org with any questions or comments.

การแก้ไขหรือการชี้แจงเล็กน้อยกับเอกสารประกอบและตัวอย่างโค้ดในที่เก็บสาธารณะครอบคลุมโดยข้อกำหนดการใช้ docs.microsoft.comMinor corrections or clarifications to documentation and code examples in public repositories are covered by the docs.microsoft.com Terms of Use. การเปลี่ยนแปลงใหม่หรือที่สำคัญจะสร้างข้อคิดเห็นในคำขอดึงข้อมูล ซึ่งขอให้คุณส่งข้อตกลงสิทธิ์การใช้งานผลงาน (CLA) แบบออนไลน์ ถ้าคุณไม่ใช่พนักงานของ MicrosoftNew or significant changes generate a comment in the pull request, asking you to submit an online Contribution License Agreement (CLA) if you are not an employee of Microsoft. เราต้องให้คุณกรอกแบบฟอร์มออนไลน์ให้เสร็จสิ้นก่อนที่เราจะสามารถรีวิวหรือยอมรับคำขอดึงข้อมูลของคุณได้We need you to complete the online form before we can review or accept your pull request.

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

การแก้ไขด่วนทำให้กระบวนการในการรายงานและแก้ไขปัญหาเล็กน้อยและการละเว้นในเอกสารเป็นไปอย่างง่ายดายQuick edits streamline the process to report and fix small errors and omissions in documents. แม้จะพยายามเพียงใด ข้อผิดพลาดด้านไวยากรณ์และการสะกด_ก็ยัง_ปรากฏในเอกสารที่เผยแพร่ของเราได้Despite all efforts, small grammar and spelling errors do make their way into our published documents. ถึงแม้คุณจะสามารถสร้างประเด็นเพื่อรายการข้อผิดพลาดได้ แต่การสร้างคำขอดึงข้อมูล (PR) เพื่อแก้ไขปัญหาก็รวดเร็วและง่ายดายกว่าเมื่อมีตัวเลือกให้ใช้งานWhile you can create issues to report mistakes, it's faster and easier to create a pull request (PR) to fix the issue, when the option is available.

  1. คุณสามารถแก้ไขเนื้อหาในหน้าเอกสารบางส่วนได้โดยตรงในเบราว์เซอร์Some docs pages allow you to edit content directly in the browser. หากคุณต้องการแก้ไข ให้มองหาปุ่ม แก้ไข ดังปุ่มที่แสดงด้านล่างIf so, you'll see an Edit button like the one shown below. การคลิกปุ่ม แก้ไข (หรือคำแปลอื่นที่เทียบเท่า) จะนำคุณไปยังไฟล์ต้นฉบับใน GitHubClicking the Edit (or equivalently localized) button takes you to the source file on GitHub. หากไม่มีปุ่ม แก้ไข หมายความว่าไม่สามารถเปลี่ยนแปลงหน้าเอกสารดังกล่าวIf the Edit button is missing, that means the documentation page is not available to be changed.

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

  2. จากนั้น คลิกไอคอนดินสอเพื่อแก้ไขบทความดังที่แสดงNext, click the pencil icon, to edit the article as shown. ถ้าไอคอนดินสอเป็นสีเทา คุณต้องลงชื่อเข้าใช้บัญชี GitHub ของคุณ หรือสร้างบัญชีใหม่ก่อนIf the pencil icon is grayed out, you need to either log in to your GitHub account or create a new account.

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

  3. เปลี่ยนแปลงสิ่งที่คุณต้องการในตัวแก้ไขบนเว็บMake your changes in the web editor. คลิกแท็บ แสดงตัวอย่างการเปลี่ยนแปลง เพื่อตรวจสอบการจัดรูปแบบการเปลี่ยนแปลงของคุณClick the Preview changes tab to check the formatting of your change.

  4. เมื่อคุณเปลี่ยนแปลงสิ่งที่ต้องการแล้ว ให้เลื่อนไปด้านล่างของหน้าOnce you have made your changes, scroll to the bottom of the page. กรอกชื่อเรื่องและคำอธิบายสำหรับการเปลี่ยนแปลงของคุณ แล้วคลิก เสนอการเปลี่ยนแปลงไฟล์ ดังที่แสดงในรูปภาพต่อไปนี้:Enter a title and description for your changes and click Propose file change as shown in the following figure:

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

  5. ตอนนี้คุณได้เสนอการเปลี่ยนแปลงแล้ว คุณจะต้องขอให้เจ้าของที่เก็บ "ดึงข้อมูล" การเปลี่ยนแปลงของคุณลงในที่เก็บนั้นNow that you've proposed your change, you need to ask the owners of the repository to "pull" your changes into their repository. การดำเนินการนี้จะทำโดยใช้สิ่งที่เรียกว่า "คำขอดึงข้อมูล"This is done using something called a "pull request". เมื่อคุณคลิกที่ เสนอการเปลี่ยนแปลงไฟล์ ในรูปด้านบน คุณควรเข้าสู่หน้าใหม่ที่มีลักษณะดังนี้:When you clicked on Propose file change in the figure above, you should have been taken to a new page that looks like the following figure:

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

    คลิก สร้างคำขอดึงข้อมูล จากนั้นป้อนชื่อ (และเลือกคำอธิบาย) สำหรับคำขอดึงข้อมูล แล้วคลิก สร้างคำขอดึงข้อมูล อีกครั้งClick Create pull request, enter a title (and optionally a description) for the pull request, and then click Create pull request again. (ถ้าคุณยังใหม่กับ GitHub ดูเกี่ยวกับคำขอดึงข้อมูลสำหรับข้อมูลเพิ่มเติม)(If you are new to GitHub, see About Pull Requests for more information.)

  6. แค่นี้เอง!That's it! สมาชิกทีมเนื้อหาจะรีวิวและผสาน PR ของคุณContent team members will review and merge your PR. คุณอาจได้รับคำติชมเมื่อร้องขอการเปลี่ยนแปลง ถ้าคุณเปลี่ยนแปลงไปหลายสิ่งYou may get some feedback requesting changes if you made larger changes.

UI การแก้ไขของ GitHub จะตอบสนองต่อสิทธิ์ในที่เก็บของคุณThe GitHub editing UI responds to your permissions on the repository. รูปภาพก่อนหน้านี้จะตรงกับผู้สนับสนุนที่ไม่มีสิทธิ์การเขียนในที่เก็บเป้าหมายThe preceding images are accurate for contributors that do not have write permissions to the target repository. GitHub จะสร้างสำเนาของที่เก็บเป้าหมายในบัญชีของคุณโดยอัตโนมัติGitHub automatically creates a fork of the target repository in your account. ถ้าคุณมีการเข้าถึงเพื่อเขียนในที่เก็บเป้าหมาย GitHub จะสร้างสาขาใหม่ขึ้นมาในที่เก็บเป้าหมายIf you have write-access to the target repository, GitHub creates a new branch in the target repo. ชื่อสาขาจะมีฟอร์ม <GitHubId>-patch-n โดนใช้ ID GitHub ของคุณและตัวเลขตัวระบุสำหรับสาขาที่แก้ไขThe branch name has the form <GitHubId>-patch-n using your GitHub ID, and a numeric identifier for the patch branch.

เราใช้คำขอดึงข้อมูลสำหรับการเปลี่ยนแปลงทั้งหมด แม้แต่กับผู้สนับสนุนที่มีการเข้าถึงเพื่อเขียนWe use pull requests for all changes, even for contributors that have write-access. ที่เก็บส่วนใหญ่มีสาขา master ที่ได้รับการป้องกัน การอัปเดตจึงต้องส่งเป็นคำขอดึงข้อมูลเท่านั้นMost repositories have the master branch protected so that updates must be submitted as pull requests.

ประสบการณ์การแก้ไขในเบราว์เซอร์จะดีที่สุดสำหรับการเปลี่ยนแปลงเล็กน้อยที่ไม่บ่อยครั้งThe in-browser editing experience is best for minor or infrequent changes. ถ้าคุณร่วมสร้างข้อมูลจำนวนมาก หรือใช้ฟีเจอร์ Git ขั้นสูง (เช่น การจัดการสาขา หรือการแก้ความขัดแย้งของการผสานขั้นสูง) คุณต้องทำสำเนาที่เก็บและทำงานในเครื่องIf you make large contributions or use advanced Git features (such as branch management or advanced merge conflict resolution), you need to fork the repo and work locally.

หมายเหตุ

เมื่อเปิดใช้งาน คุณสามารถแก้ไขบทความในภาษาใดก็ได้ และสิ่งต่อไปนี้จะเกิดขึ้นตามประเภทของการแก้ไข:If enabled, you can edit an article in any language and, based on the type of edit, the following will happen:

  1. การเปลี่ยนแปลงด้านภาษาทั้งหมดที่ได้รับอนุมัติจะช่วยปรับปรุงโปรแกรมการแปลด้วยเครื่องของเราany linguistic change that is approved, will also help improve our Machine Translation engine
  2. การแก้ไขทั้งหมดที่ปรับเปลี่ยนเนื้อหาของบทความอย่างมากจะได้รับการจัดการภายในเพื่อส่งการเปลี่ยนแปลงไปยังบทความเดียวกันในภาษาอังกฤษเพื่อแปลเป็นภาษาต่างๆ ทุกภาษา ถ้าได้รับอนุมัติany edit that significantly modifies the content of the article will be handled internally to submit a change to the same article in English so that it will get localized in all languages if approved. การปรับปรุงที่แนะนำของคุณจะไม่เพียงแต่ส่งผลในแง่บวกต่อบทความในภาษาของคุณเองเท่านั้น แต่ในภาษาที่มีอยู่ทั้งหมดด้วยYour suggested improvements will not only positively affect articles in your own language, but in all available languages.

รีวิว PR แบบเปิดReview open PRs

คุณสามารถอ่านหัวข้อใหม่ได้ก่อนที่จะเผยแพร่โดยตรวจสอบ PR แบบเปิดในปัจจุบันYou can read new topics before they are published by checking the currently open PRs. การรีวิวจะเป็นไปตามกระบวนการ โฟลว์ของ GitHubReviews follow the GitHub flow process. คุณสามารถดูการอัปเดตที่เสนอหรือบทความใหม่ได้ในที่เก็บสาธารณะYou can see proposed updates or new articles in public repositories. รีวิวแล้วเพิ่มข้อคิดเห็นของคุณReview them and add your comments. ดูที่เก็บเอกสารใดๆ ของเรา แล้วตรวจสอบคำขอดึงข้อมูล (PR) แบบเปิดของพื้นที่ที่คุณสนใจLook at any of our docs repositories, and check the open pull requests (PRs) for areas that interest you. คำติชมของชุมชนเกี่ยวกับการอัปเดตที่เสนอจะช่วยเหลือทั้งชุมชนCommunity feedback on proposed updates helps the entire community.

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

เอกสารของเราเป็นงานในระหว่างกระบวนการอยู่ตลอดเวลาOur docs are a continuous work in progress. ประเด็นที่ดีช่วยให้เราโฟกัสการทำงานของเราไปที่สิ่งที่สำคัญที่สุดสำหรับชุมชนได้Good issues help us focus our efforts on the highest priorities for the community. ยิ่งคุณให้รายละเอียดเราได้เท่าไร ประเด็นนั้นยิ่งมีประโยชน์ขึ้นเท่านั้นThe more detail you can provide, the more helpful the issue. บอกเราว่าคุณกำลังมองหาข้อมูลแบบใดTell us what information you sought. บอกเราว่าคุณใช้คำค้นหาอะไรTell us the search terms you used. ถ้าคุณไม่สามารถเริ่มต้นได้ บอกเราว่าคุณต้องการเริ่มสำรวจเทคโนโลยีที่ไม่คุ้นเคยอย่างไรIf you can't get started, tell us how you want to start exploring unfamiliar technology.

เอกสารของ Microsoft หลายหน้าจะมีส่วน คำติชม ที่ด้านล่างของหน้า ซึ่งคุณสามารถคลิกเพื่อให้ คำติชมเกี่ยวกับผลิตภัณฑ์ หรือ คำติชมเกี่ยวกับเนื้อหา เพื่อติดตามประเด็นที่เฉพาะเจาะจงกับบทความMany of Microsoft's documentation pages have a Feedback section at the bottom of the page where you can click to leave Product feedback or Content feedback to track issues that are specific to that article.

ประเด็นจะเริ่มการสนทนาเกี่ยวกับสิ่งที่จำเป็นIssues start the conversation about what's needed. ทีมเนื้อหาจะตอบสนองต่อประเด็นเหล่านี้ด้วยแนวคิดของสิ่งที่เราสามารถเพิ่มลงไปได้ และถามถึงความคิดเห็นของคุณThe content team will respond to these issues with ideas for what we can add, and ask for your opinions. เมื่อเราสร้างแบบร่าง เราจะขอให้คุณรีวิว PR นั้นWhen we create a draft, we'll ask you to review the PR.

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

หัวข้ออื่นช่วยให้คุณเริ่มมีส่วนร่วมอย่างมีประสิทธิภาพกับ Microsoft Docs หัวข้อต่างๆ จะอธิบายการทำงานกับที่เก็บ GitHub เครื่องมือ Markdown และส่วนขยายที่ใช้ในแพลตฟอร์ม Microsoft DocsOther topics help you get started productively contributing to Microsoft Docs. They explain working with GitHub repositories, Markdown tools, and extensions used in the Microsoft Docs platform.