ปรับปรุงคู่มือนี้¶
ต้นฉบับของคู่มือจัดเก็บเป็น Markdown ในไดเรกทอรี docs/ และสร้างเว็บไซต์ด้วย MkDocs
การแสดงตัวอย่างในท้องถิ่น¶
สร้างสภาพแวดล้อมเสมือนและติดตั้งการขึ้นต่อกันของเอกสาร:
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
เปิดที่อยู่ในเครื่องที่พิมพ์โดย MkDocs การแสดงตัวอย่างจะสร้างขึ้นใหม่เมื่อไฟล์ต้นฉบับมีการเปลี่ยนแปลง
ตรวจสอบเว็บไซต์¶
ก่อนที่จะเปิดคำขอดึง:
โครงสร้างที่เข้มงวดรายงานว่าไม่มีรายการการนำทาง ลิงก์ที่ไม่ถูกต้องที่ MkDocs ตรวจพบ และคำเตือนการกำหนดค่า
หลักการเขียน¶
- เขียนสำหรับงานเฉพาะและผู้ชม
- ระบุเวอร์ชัน MRBS เมื่อลักษณะการทำงานเป็นแบบเฉพาะรุ่น
- ต้องการตัวอย่างที่ทดสอบมากกว่ารายการที่ครบถ้วนสมบูรณ์
- อย่าใส่ข้อมูลประจำตัวจริงหรือข้อมูลการจองส่วนตัว
- เชื่อมโยงงานที่เกี่ยวข้องแทนการทำซ้ำส่วนขนาดใหญ่
- อัปเดตคำแปลที่มีอยู่ทั้งหมดเมื่อใช้งานได้จริง
การแปล¶
ภาษาอังกฤษเป็นข้อความอ้างอิง หน้าภาษาเยอรมัน ฝรั่งเศส และสเปนใช้เส้นทางสัมพัทธ์เดียวกันกับคำต่อท้ายสถานที่:
เมื่อคำแปลหายไป ไซต์จะกลับไปเป็นภาษาอังกฤษ การแปลควรรักษาโค้ด ชื่อการตั้งค่า คำเตือน และลิงก์ไว้ในขณะที่ใช้คำศัพท์ทั่วไปในภาษาเป้าหมาย
ขอบเขต¶
แผนผังเอกสารนี้มีเป้าหมาย MRBS 1.12.2 การเปลี่ยนแปลงที่อธิบายการเปิดตัวในภายหลังจะต้องอัปเดตขอบเขตเวอร์ชันที่มองเห็นได้หรือได้รับการพัฒนาในชุดเอกสารประกอบสำหรับการเปิดตัวนั้น