สร้างเอกสารประกอบผู้ใช้สำหรับส่วนขยายของคุณ

ส่วนขยายทุกรายการต้องมีเอกสารประกอบที่อธิบายให้ผู้ใช้ทราบถึงสิ่งที่ส่วนขยายทําและวิธีใช้

เอกสารขั้นต่ำที่จำเป็นคือชุดไฟล์มาร์กดาวน์ 3 ไฟล์ต่อไปนี้

• PREINSTALL.md
• POSTINSTALL.md
• CHANGELOG.md

นอกจากนี้ คุณควรพิจารณาสร้างเนื้อหาต่อไปนี้ด้วย

• ไฟล์ README สำหรับที่เก็บสาธารณะของส่วนขยาย
• บทแนะนำแบบยาว คำแนะนำ และข้อมูลอ้างอิงที่เผยแพร่ในเว็บไซต์ของคุณเองและ ที่ลิงก์ใน PREINSTALL.md ของคุณ

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

การสร้างไฟล์ README

ไดเรกทอรีส่วนขยายของคุณอาจมีไฟล์ README หรือไม่ก็ได้ โปรดทราบว่าคำสั่ง firebase ext:dev:init จะไม่สร้างรายการให้คุณโดยอัตโนมัติ

อย่างไรก็ตาม CLI ของ Firebase รองรับคำสั่งอำนวยความสะดวกต่อไปนี้เพื่อสร้างไฟล์ README ที่มีเนื้อหาที่ดึงมาจากไฟล์ extension.yaml และไฟล์ PREINSTALL.md โดยอัตโนมัติ

firebase ext:info ./path/to/extension --markdown > README.md

ไฟล์ README ทั้งหมดสําหรับส่วนขยาย Firebase อย่างเป็นทางการสร้างขึ้นโดยใช้คําสั่งนี้

เพิ่มข้อมูลการติดตั้ง

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

---

## 🧩 Install this extension

### Console

[![Install this extension in your Firebase project](https://www.gstatic.com/mobilesdk/210513_mobilesdk/install-extension.png "Install this extension in your Firebase project")][install-link]

[install-link]: https://console.firebase.google.com/project/_/extensions/install?ref=publisher_id/extension_name

### Firebase CLI

```bash
firebase ext:install publisher_id/extension_name --project=[your-project-id]
```

> Learn more about installing extensions in the Firebase Extensions documentation:
> [console](https://firebase.google.com/docs/extensions/install-extensions?platform=console),
> [CLI](https://firebase.google.com/docs/extensions/install-extensions?platform=cli)

---

กำลังเขียนไฟล์ PREINSTALL

ไฟล์ PREINSTALL คือภาพรวมของส่วนขยาย ซึ่งเป็นประเภทหนึ่งของ "การตลาด"

ไฟล์นี้มีเนื้อหาอะไร

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

เนื้อหานี้แสดงต่อผู้ใช้ที่ใด

คอนโซล Firebase">

คอนโซล Firebase">

• ในหน้าส่วนขยายบน extensions.dev
• ที่เก็บซอร์สโค้ดสำหรับส่วนขยายของคุณ (ภายในไดเรกทอรีส่วนขยาย)
• เป็นส่วนหนึ่งของ README ของส่วนขยาย (หากคุณใช้Firebase CLI --markdown > README.md flag)

ไฟล์ PREINSTALL ไม่สามารถเข้าถึงค่าพารามิเตอร์สําหรับส่วนขยายได้ คุณจึงไม่ควรคาดหวังว่าการอ้างอิงพารามิเตอร์จะแสดงผลด้วยค่าจริง

แนวทางปฏิบัติแนะนำมีอะไรบ้าง

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

Billing

This extension uses other Firebase or Google Cloud services which may have
  associated charges:

*   <list Google services / products that your extension uses>
*   <list Firebase services that your extension uses>
*   Cloud Secret Manager <if the extension uses secret params>
*   Cloud Functions

When you use Firebase Extensions, you're only charged for the underlying
resources that you use. A paid-tier billing plan is only required if the
extension uses a service that requires a paid-tier plan, for example calling to
a Google Cloud API or making outbound network requests to non-Google services.
All Firebase services offer a no-cost tier of usage.
[Learn more about Firebase billing.](https://firebase.google.com/pricing)

<Applicable info about billing implications for non-Google services, such as:>
Usage of this extension also requires you to have a <non-Google-service> account.
You are responsible for any associated costs with your usage of <non-Google-service>.

กำลังเขียนไฟล์ POSTINSTALL

ไฟล์ POSTINSTALL คือรายละเอียดหลังการติดตั้งของส่วนขยาย หน้าการสอน

ไฟล์นี้มีเนื้อหาอะไร

• คำแนะนำโดยละเอียดสำหรับงานหลังการติดตั้งที่จำเป็น เช่น การตั้งค่ากฎความปลอดภัยของ Firebase หรือเพิ่มโค้ดฝั่งไคลเอ็นต์ (ตัวอย่าง)
• คำแนะนำทั่วไปเกี่ยวกับวิธีทดลองใช้ ส่วนขยายที่ติดตั้ง (เช่น "ไปที่คอนโซลแล้วดำเนินการ")
• ข้อมูลพื้นฐานเกี่ยวกับวิธีเรียกส่วนขยาย โดยเฉพาะสำหรับ ส่วนขยายที่ทริกเกอร์โดยคำขอ HTTP
• คำแนะนำโดยย่อเกี่ยวกับวิธีตรวจสอบส่วนขยายที่ติดตั้ง (เริ่มต้นด้วย ข้อความสำเร็จรูป)

เนื้อหานี้แสดงที่ใดให้ผู้ใช้เห็น

คอนโซล Firebase">

คอนโซล Firebase">

• ในคอนโซล Firebase หลังจากที่ผู้ใช้ติดตั้งส่วนขยาย (ในการ์ดรายละเอียดของส่วนขยายที่ติดตั้ง)

  • อย่าลืมตรวจสอบการแสดงเนื้อหา POSTINSTALL โดยติดตั้งส่วนขยายในโปรเจ็กต์จริง

• ที่เก็บซอร์สโค้ดสำหรับส่วนขยาย (ภายในไดเรกทอรีส่วนขยาย)

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

แนวทางปฏิบัติแนะนำมีอะไรบ้าง

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

การอ้างอิงพารามิเตอร์และตัวแปร

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

เข้าถึงค่าพารามิเตอร์ที่กําหนดค่าไว้ในไฟล์ POSTINSTALL โดยใช้ไวยากรณ์ต่อไปนี้ ${param:PARAMETER_NAME}

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

ในตารางนี้ function-name คือค่าของช่อง name ในออบเจ็กต์ทรัพยากรของฟังก์ชันภายใน extension.yaml

Monitoring

As a best practice, you can
[monitor the activity](https://firebase.google.com/docs/extensions/manage-installed-extensions_community#monitor)
of your installed extension, including checks on its health, usage, and logs.

บันทึกวิธีเรียกให้ส่วนขยายทำงาน

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

กำลังเขียนไฟล์ CHANGELOG

ไฟล์นี้มีเนื้อหาใดบ้าง

ส่วนขยายทุกรายการต้องมีไฟล์ CHANGELOG.md ที่บันทึกการเปลี่ยนแปลงซึ่งรวมอยู่ในส่วนขยายเวอร์ชันใหม่แต่ละเวอร์ชันที่คุณเผยแพร่ ป้อนแต่ละเวอร์ชัน ภายใต้ส่วนหัวระดับ 2 (##); หรือไม่ก็ใช้มาร์กดาวน์ การจัดรูปแบบที่คุณต้องการ

ตัวอย่างต่อไปนี้เป็นข้อความที่ตัดตอนมาจากส่วนขยายอย่างเป็นทางการรายการใดรายการหนึ่ง

## Version 0.1.3

feature - Support deletion of directories (issue #148).

## Version 0.1.2

feature - Add a new param for recursively deleting subcollections in Cloud
Firestore (issue #14).

fixed - Fixed "cold start" errors experienced when the extension runs after a
period of inactivity (issue #48).

## Version 0.1.1

Initial release of the _Delete User Data_ extension.

เนื้อหานี้แสดงต่อผู้ใช้ที่ใด

• ในคอนโซล Firebase และ CLI เมื่อผู้ใช้อัปเกรดเป็นเวอร์ชันใหม่ ส่วนขยาย คอนโซล Firebase และ CLI จะแสดงเฉพาะการเปลี่ยนแปลงที่ จะมีผลถ้าผู้ใช้ทำการอัปเกรดให้เสร็จสมบูรณ์
• รีโปซอร์สโค้ดของส่วนขยาย (ภายในไดเรกทอรีส่วนขยาย)