ให้เอกสารประกอบผู้ใช้ของตัวเชื่อมต่อแบบปรับแต่งเองของคุณ

เมื่อคุณเสร็จสิ้นการออกแบบตัวเชื่อมต่อแบบPower Queryเองของคุณแล้ว คุณจะต้องส่งบทความที่มีคําแนะนําเกี่ยวกับวิธีการใช้ตัวเชื่อมต่อของคุณการเผยแพร่บน docs.microsoft.com บทความนี้อธิบายถึงเค้าโครงของบทความดังกล่าวและวิธีการจัดรูปแบบข้อความของบทความของคุณ

เค้าโครงบทความ

ในส่วนนี้จะอธิบายเค้าโครงทั่วไปของPower Queryตัวเชื่อมต่อของคุณ บทความตัวเชื่อมต่อแบบปรับแต่งเองของคุณควรเป็นไปตามเค้าโครงทั่วไปนี้

ตารางสรุป

บทความPower Queryตัวเชื่อมต่อทั้งหมดเริ่มต้นด้วยตารางสรุปที่ประกอบด้วยข้อมูลต่อไปนี้:

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

ตารางสรุปตัวอย่าง

หากตัวเชื่อมต่อแบบปรับแต่งของคุณถูกใช้งานในผลิตภัณฑ์ต่าง ๆ แต่มีความสามารถที่แตกต่างกันในผลิตภัณฑ์เหล่านี้ ให้รวมถึงหมายเหตุต่อไปนี้หรือที่คล้ายกันในบทความของคุณหลังจากตารางสรุป:

หมายเหตุ

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

สิ่งที่จำเป็นต้องมี

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

รองรับความสามารถ

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

คําแนะนําการเชื่อมต่อ

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

ขั้นตอนถูกสร้างขึ้นจากรายการที่มีตัวเลขที่รวมถึงแต่ละขั้นตอนที่ต้องกรอกข้อมูลที่ต้องใช้ในการเชื่อมต่อปกติ (ไม่ต้องใช้ตัวเลือกล่วงหน้า) กับข้อมูล

เชื่อมต่อตัวเลือกขั้นสูง (ไม่บังคับ)

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

การแก้ไขปัญหา (ไม่บังคับ)

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

คําแนะนําเพิ่มเติม (ไม่บังคับ)

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

สถานที่ตั้งและรูปแบบของบทความ

บทความของคุณควรจะพร้อมใช้งานบน GitHub ภายใต้โฟลเดอร์ ตัวเชื่อมต่อ ใน repo Power Query https://github.com/MicrosoftDocs/powerquery-docs/tree/master/powerquery-docs/Connectors เอกสาร: ตรวจสอบให้แน่ใจว่าคุณได้เพิ่มลิงก์ไปยังบทความของคุณ ในรายการของตัวเชื่อมต่อ ที่อ้างอิงรูปโลโก้ที่ถูกต้องที่อัปโหลด /Connectors/media/index ไปยังโฟลเดอร์ สุดท้าย ตรวจสอบให้แน่ใจว่าคุณเพิ่มลิงก์ไปยังบทความของคุณในไฟล์สารบัญ ( TOC.yml ) ตัวเชื่อมต่อที่ได้รับการรับรองจะสามารถใช้ได้ภายใต้ Power BI (ชุดข้อมูล) เท่านั้น

ดูคู่มือ เอกสาร Microsoftผู้ร่วมสร้าง ของเราเกี่ยวกับวิธีที่คุณสามารถมีส่วนร่วมกับ repo ของเรา

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

บทความต่อไปนี้มีคําแนะนําเกี่ยวกับการจัดรูปแบบเอกสารของคุณใน Markdown และสไตล์ของ Microsoft ที่คุณควรปฏิบัติตามเมื่อเขียนบทความของคุณ:

บทความตัวเชื่อมต่อตัวอย่าง

นี่คือตัวอย่างสองPower Queryตัวอย่างในบทความตัวเชื่อมต่อที่คุณสามารถใช้เป็นจุดเริ่มต้น: