รายการตรวจสอบบรรณาธิการ

นี่คือบทสรุปกฎเกณฑ์ที่ใช้เมื่อเขียนบทความใหม่หรืออัปเดตบทความที่มีอยู่ ดูบทความอื่นๆ ในคู่มือผู้ร่วมให้ข้อมูลสำหรับคำอธิบายโดยละเอียดและตัวอย่างกฎเหล่านี้

ข้อมูลเมตา

• ms.date: ต้องอยู่ในรูปแบบ MM/DD/YYYY

  • เปลี่ยนวันที่ที่มีการอัพเดตที่สำคัญหรือเป็นข้อเท็จจริง

    • การจัดระเบียบบทความใหม่
    • การแก้ไขข้อผิดพลาดข้อเท็จจริง
    • การเพิ่มข้อมูลใหม่

  • อย่าเปลี่ยนวันที่หากการอัปเดตไม่มีนัยสำคัญ

    • แก้ไขการพิมพ์ผิดและการจัดรูปแบบ

• title: สตริงเฉพาะที่มีความยาว 43-59 ตัวอักษร (รวมการเว้นวรรค)

  • ไม่รวมตัวระบุไซต์ (สร้างขึ้นอัตโนมัติ)
  • ใช้กรณีประโยค - ใช้ตัวพิมพ์ใหญ่เฉพาะคำแรกและคำนามที่เหมาะสม
• คำอธิบาย: 115-145 ตัวอักษรรวมช่องว่าง - บทคัดย่อนี้จะแสดงในผลการค้นหา

การจัดรูปแบบ

• องค์ประกอบไวยากรณ์ Backtick ที่ปรากฏแบบอินไลน์ภายในย่อหน้า

  • ชื่อ Cmdlet กริยา-คำนาม
  • ตัวแปร $counter
  • ตัวอย่างวากยสัมพันธ์ กริยา-คำนาม -พารามิเตอร์
  • เส้นทางไฟล์ C:\Program Files\PowerShell, /usr/bin/pwsh
  • URL ที่ไม่ต้องการให้คลิกได้ในเอกสาร
  • ค่าคุณสมบัติหรือพารามิเตอร์

• ใช้ตัวหนาสำหรับชื่อคุณสมบัติ ชื่อพารามิเตอร์ ชื่อคลาส ชื่อโมดูล ชื่อเอนทิตี ชื่อวัตถุหรือประเภท

  • ตัวหนาใช้สำหรับมาร์กอัปความหมาย ไม่ใช่การเน้น
  • ตัวหนา - ใช้เครื่องหมายดอกจัน **

• ตัวเอียง - ใช้ขีดล่าง _

  • ใช้สำหรับการเน้นเท่านั้น ไม่ใช่สำหรับมาร์กอัปเชิงความหมาย
• แบ่งบรรทัดที่ 100 คอลัมน์ (หรือที่ 80 สำหรับ about_Topics)
• ไม่มีฮาร์ดแท็บ - ใช้ช่องว่างเท่านั้น
• ไม่มีช่องว่างต่อท้ายบนบรรทัด
• คำสำคัญและตัวดำเนินการของ PowerShell ควรเป็นตัวพิมพ์เล็กทั้งหมด
• ใช้ตัวพิมพ์ (Pascal) ที่เหมาะสมสำหรับชื่อ cmdlet และพารามิเตอร์

ส่วนหัว

• H1 เป็นอันดับแรก - เพียงหนึ่ง H1 ต่อบทความ
• ใช้ส่วนหัว ATX เท่านั้น
• ใช้ตัวพิมพ์ประโยคสำหรับส่วนหัวทั้งหมด
• อย่าข้ามระดับ - ห้ามใช้ H3 โดยไม่มี H2
• ความลึกสูงสุดของ H3 หรือ H4
• บรรทัดว่างก่อนและหลัง
• PlatyPS บังคับใช้ส่วนหัวเฉพาะในสคีมา - อย่าเพิ่มหรือลบส่วนหัว

บล็อกรหัส

• บรรทัดว่างก่อนและหลัง
• ใช้รั้วโค้ดที่ติดแท็ก - powershell, เอาต์พุต หรือรหัสภาษาอื่นที่เหมาะสม
• รั้วที่ไม่ติดแท็ก - บล็อกไวยากรณ์หรือเชลล์อื่น ๆ
• ใส่เอาต์พุตในบล็อกโค้ดแยกต่างหาก ยกเว้นตัวอย่างพื้นฐานที่คุณไม่ต้องการให้ผู้อ่านใช้ปุ่ม คัดลอก
• ดูรายการภาษาที่รองรับ

รายการ

• เยื้องอย่างถูกต้อง
• บรรทัดว่างก่อนรายการแรกและหลังรายการสุดท้าย
• สัญลักษณ์แสดงหัวข้อย่อย - ใช้ยัติภังค์ (-) ไม่ใช่เครื่องหมายดอกจัน (*) เพื่อลดความสับสนด้วยการเน้น
• สำหรับรายการลำดับเลข ตัวเลขทั้งหมดคือ "1"

คำศัพท์เฉพาะทาง

• PowerShell กับ Windows PowerShell
• ดูคำศัพท์เฉพาะของผลิตภัณฑ์

ตัวอย่างการอ้างอิง Cmdlet

• ต้องมีอย่างน้อยหนึ่งตัวอย่างในการอ้างอิง cmdlet

• ตัวอย่างควรเป็นเพียงโค้ดที่เพียงพอที่จะสาธิตการใช้งาน

• ไวยากรณ์ของ PowerShell

  • ใช้ชื่อเต็มของ cmdlets และพารามิเตอร์ - ไม่มีนามแฝง
  • ใช้การสลับสำหรับพารามิเตอร์เมื่อบรรทัดคำสั่งยาวเกินไป
  • หลีกเลี่ยงการใช้ backticks ที่ต่อเนื่องกันของบรรทัด - ใช้เมื่อจำเป็นเท่านั้น

• ลบหรือลดความซับซ้อนของพรอมต์ PowerShell (PS>) ยกเว้นในกรณีที่จำเป็นสำหรับตัวอย่าง

• ตัวอย่างการอ้างอิง Cmdlet ต้องเป็นไปตามสคีมา PlatyPS ต่อไปนี้

  ### Example 1 - Descriptive title
  
  Zero or more short descriptive paragraphs explaining the context of the example followed by one or
  more code blocks. Recommend at least one and no more than two.
  
  ```powershell
  ... one or more PowerShell code statements ...
  ```
  
  ```Output
  Example output of the code above.
  ```
  
  Zero or more optional follow up paragraphs that explain the details of the code and output.
  

• อย่าใส่ย่อหน้าระหว่างบล็อคโค้ด เนื้อหาเชิงอธิบายทั้งหมดต้องมาก่อนหรือหลังบล็อคโค้ด

การเชื่อมโยงไปยังเอกสารอื่นๆ

• เมื่อเชื่อมโยงภายนอกชุดเอกสารหรือระหว่างการอ้างอิง cmdlet และแนวความคิด

  • ใช้ URL ที่เกี่ยวข้องกับไซต์เมื่อเชื่อมโยงไปยัง Microsoft Learn (ลบ https://learn.microsoft.com/en-us)
  • ไม่รวมภาษาใน URL บนคุณสมบัติของ Microsoft (เช่น ลบ /en-us ออกจาก URL)
  • URL ทั้งหมดไปยังเว็บไซต์ภายนอกควรใช้ HTTPS เว้นแต่จะไม่ถูกต้องสำหรับไซต์เป้าหมาย

• เมื่อทำการเชื่อมโยงภายใน docset

  • ใช้เส้นทางไฟล์แบบสัมพันธ์ (เช่น ../folder/file.md)
• เส้นทางทั้งหมดใช้อักขระเครื่องหมายทับ (/)
• ลิงก์รูปภาพควรมีข้อความแสดงแทนที่ไม่ซ้ำกัน