การจัดทําเอกสารของผู้ใช้สําหรับตัวเชื่อมต่อแบบกําหนดเองของคุณ

  • บทความ

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

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

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

หมายเหตุการสนับสนุน

ต่อท้ายชื่อเรื่องของบทความ ให้แทรกบันทึกย่อต่อไปนี้

หมายเหตุ

บทความตัวเชื่อมต่อต่อไปนี้มีให้ตาม<ชื่อ>บริษัท เจ้าของตัวเชื่อมต่อนี้และสมาชิกของโปรแกรมการรับรอง Microsoft Power Query เชื่อมต่อ OR หากคุณมีคําถามเกี่ยวกับเนื้อหาของบทความนี้หรือมีการเปลี่ยนแปลงที่คุณต้องการเห็นในบทความนี้ ให้เยี่ยมชม <เว็บไซต์ชื่อ> บริษัทและใช้ช่องสนับสนุนที่นั่น

แทนที่ <ชื่อ> บริษัทด้วยชื่อบริษัทของคุณ

ตารางสรุป

หลังจากบันทึกย่อการสนับสนุน ให้ระบุตารางสรุปที่ประกอบด้วยข้อมูลต่อไปนี้:

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

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

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

หมายเหตุ

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

ข้อกำหนดเบื้องต้น

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

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

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

คําแนะนําเกี่ยวกับเชื่อมต่อ

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

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

หมายเหตุ

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

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

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

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

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

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

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

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

รูปแบบชื่อไฟล์สําหรับบทความตัวเชื่อมต่อของคุณควรประกอบด้วยตัวอักษรพิมพ์เล็กเท่านั้น โดยมีเครื่องหมายยัติภังค์ระหว่างคํา ตัวอย่างเช่น ชื่อไฟล์สําหรับตัวเชื่อมต่อ Azure Blob Storage azure-blob-storage.md ถ้าชื่อตัวเชื่อมต่อของคุณใช้ตัวย่อ ตัวย่อทั้งหมดจะนับเป็นหนึ่งคํา ตัวอย่างเช่น ชื่อไฟล์สําหรับตัวเชื่อมต่อ Hive LLAP hive-llap.md

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

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

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

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

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

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