ข้ามไปยังเนื้อหาหลัก

คู่มือแนวทาง

Guides Banner

เพื่อให้มั่นใจว่าเนื้อหาใน ZAP-Docs ของเรามีคุณภาพและสไตล์ที่สม่ำเสมอ เราจึงได้สร้างแนวทางต่างๆ สำหรับใช้เมื่อสร้างหรือแก้ไขเนื้อหาสำหรับเอกสารของเรา คุณ ต้อง ปฏิบัติตามแนวทางของเราอย่างเคร่งครัดเพื่อให้คำแนะนำและคำขอดึงข้อมูลสุดท้ายของคุณได้รับการดำเนินการอย่างรวดเร็ว ที่สำคัญกว่านั้นคือ จะช่วยให้ผู้อ่านได้รับประสบการณ์ที่ดีและมีคุณภาพสูงอย่างสม่ำเสมอขณะอ่านและทำตามคู่มือ

แนวทางการมีส่วนร่วมในคู่มือของเราแบ่งออกเป็นส่วนต่างๆ ดังนี้:

  • โครงสร้าง
  • สไตล์
  • การจัดรูปแบบ
  • คำศัพท์

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

โครงสร้าง​

คู่มือทั้งหมดใน ZAP-Docs ของเราจะมีโครงสร้างที่ค่อนข้างสม่ำเสมอ เริ่มต้นด้วยบทนำสั้นๆ พร้อมกับข้อกำหนดเบื้องต้นหรือขั้นตอนการเตรียมตัว ตามด้วยเนื้อหาหลักและบทสรุปสั้นๆ

โครงสร้างนี้อาจมีการปรับเปลี่ยนได้บ้างขึ้นอยู่กับประเภทของคู่มือที่สร้างขึ้น ซึ่งสามารถพูดคุยกับทีม ZAP-Docs ในขั้นตอนการเสนอครั้งแรกได้ คุณสามารถดูวิธีใช้หัวข้อผ่านส่วน headers ซึ่งทำผ่าน Markdown แบบดั้งเดิม

โครงสร้างที่เราคาดหวังโดยทั่วไปจะมีหัวข้อต่อไปนี้:

  • ชื่อหน้า (H1) - กำหนดผ่าน title metadata ที่ด้านบนของหน้า
  • บทนำ (H2) - ประโยคสั้น 1-2 ประโยคที่อธิบายหัวข้อของคู่มือและที่สำคัญคืออธิบายวัตถุประสงค์ของคู่มือ
  • การเตรียมตัว (H2) - หัวข้อนี้ ไม่บังคับ ใช้เฉพาะเมื่อมีข้อกำหนดเบื้องต้นหรือขั้นตอนเตรียมตัวที่ต้องทำก่อนผู้อ่านจะทำตามคู่มือ เช่น คุณอาจอ้างอิงคู่มือ SSH Initial Access หากผู้ใช้ต้องล็อกอินเข้าเซิร์ฟเวอร์ก่อน หรืออาจแสดงซอฟต์แวร์และ/หรือฮาร์ดแวร์ที่จำเป็น หรือให้คำแนะนำสั้นๆ ในการเตรียมซอฟต์แวร์ เช่น ไฟร์วอลล์ เราแนะนำให้คุณดูคู่มือใน เว็บไซต์ ZAP-Docs ว่ามีคู่มือที่ครอบคลุมขั้นตอนเหล่านี้หรือไม่ และถ้ามีให้ลิงก์ไปยังคู่มือนั้น
  • หัวข้อหลัก (H2) - ส่วนหลักแรกของคู่มือ ในหลายกรณีมักจะตั้งชื่อว่า การติดตั้ง ซึ่งจะตามด้วยหัวข้อย่อยต่างๆ สำหรับแต่ละขั้นตอน แต่ไม่จำเป็นต้องเป็นแบบนี้เสมอไป เช่น คู่มือข้อมูลอาจมีหัวข้อหลักที่แตกต่างกัน
  • ตัวเลือก: หัวข้อย่อย 1 (H3)
  • ตัวเลือก: หัวข้อย่อย 2 (H3)
  • ...
  • ตัวเลือก: หัวข้ออื่นๆ (H2)
  • บทสรุป (H2) - ส่วนสุดท้ายของคู่มือ ควรสรุปใน 1-3 ประโยค อธิบายว่าผู้อ่านทำอะไรสำเร็จไปแล้ว และแนะนำให้ติดต่อทีมซัพพอร์ตหากยังมีปัญหา
การใช้หัวข้อย่อย (H3 & H4)

คุณควรใช้หัวข้อ H3 เพื่อสร้างหัวข้อย่อยภายในหัวข้อหลัก H2 เพื่อจัดระเบียบเนื้อหาที่ใหญ่ขึ้นให้เป็นส่วนๆ ที่เป็นระเบียบ ตัวอย่างเช่นในส่วน หัวข้อหลัก ข้างต้น

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

ถ้าใช้หัวข้อย่อย ควรมีอย่างน้อยสองหัวข้อย่อยขึ้นไปในหัวข้อหลัก มิฉะนั้นจะไม่สมเหตุสมผลที่จะมีหัวข้อย่อยเดียวในหัวข้อหลัก

ในอนาคต เราจะเพิ่มเทมเพลตที่มี Markdown เตรียมไว้ล่วงหน้าให้คุณ ซึ่งจะเป็นจุดเริ่มต้นที่ดีสำหรับการสร้างหน้าใหม่ เราจะเพิ่มเร็วๆ นี้

ชื่อเรื่อง​

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

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

ตัวอย่างชื่อเรื่องที่ดีสำหรับคู่มือเกี่ยวกับผลิตภัณฑ์ VPS คือ: VPS: SteamCMD Linux Setup

บทนำ​

บทนำของคู่มือควรสั้นและตรงประเด็น โดยปกติจะมีความยาว 1-2 ประโยค ในเนื้อหาคุณควรอธิบายหัวข้อโดยย่อและที่สำคัญคืออธิบายว่าคู่มือจะนำเสนออะไรให้ผู้อ่าน และแจ้งเป้าหมายสุดท้าย

ตัวอย่างบทนำที่เหมาะสมสำหรับคู่มือเกี่ยวกับ SteamCMD คือ:

  • ประโยคที่ 1: SteamCMD เป็นเครื่องมือสำคัญที่จำเป็นสำหรับการติดตั้งเซิร์ฟเวอร์เฉพาะสำหรับเกมหลากหลาย เช่น Palworld, Enshrouded และอื่นๆ
  • ประโยคที่ 2: ในคู่มือนี้ เราจะสำรวจขั้นตอนการตั้งค่า SteamCMD ครั้งแรกบนเซิร์ฟเวอร์ Linux ของคุณ โดยใช้ Ubuntu เป็นตัวอย่าง แต่กระบวนการควรคล้ายกันกับดิสทริบิวชันอื่นๆ

ตามตัวอย่างนี้ จะสรุปหัวข้อที่เกี่ยวข้องและนำเสนอเป้าหมายโดยรวมให้ผู้อ่านเข้าใจเมื่อทำตามคู่มือ

การเตรียมตัว​

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

เราแนะนำให้คุณค้นหาคู่มือใน เว็บไซต์ ZAP-Docs เพื่อดูว่ามีคู่มือที่ครอบคลุมหรือเกี่ยวข้องกับขั้นตอนเตรียมตัวที่คุณจะใส่หรือไม่ หากมีคู่มือ เช่น SSH Initial Access คุณควรลิงก์และแจ้งให้ผู้อ่านทำตามก่อนดำเนินการต่อ

ข้อกำหนดเบื้องต้นทั่วไปสำหรับคู่มือมีดังนี้:

  • ซอฟต์แวร์ที่จำเป็น (เช่น Git, Node.js, Python, Docker)
  • คู่มือที่ช่วยให้ผู้อ่านมีความรู้พื้นฐาน (เช่น คู่มือ ZAP-Docs อื่นๆ)
  • บัญชีผู้ใช้ เช่น API
  • การตั้งค่าที่จำเป็น (เช่น DNS/SSL)

ตัวอย่างสำหรับคู่มือ Reverse Proxy คือ:

ในการตั้งค่า reverse proxy คุณจะต้องมี Linux Server เพื่อโฮสต์ proxy server และควรเชื่อมต่อเข้าไป ใช้คู่มือ [SSH Initial Access](vserver-linux-ssh.md) ของเรา หากต้องการความช่วยเหลือในการทำเช่นนี้ คุณจะต้องมีการเข้าถึงโดเมนที่คุณเป็นเจ้าของ สำหรับแต่ละซับโดเมนที่คุณวางแผนจะใช้ คุณควรสร้างระเบียน DNS แบบ `A` ชี้ไปยังที่อยู่ IP ของ Linux Server ของคุณ

หัวข้อหลัก​

ถึงเวลาที่จะเขียนเนื้อหาหลักของคู่มือ คุณสามารถใช้หัวข้อ H2, H3 และ H4 เพื่อจัดโครงสร้างคู่มืออย่างเหมาะสม โดยใช้ H2 สำหรับส่วนใหญ่และแบ่งย่อยด้วย H3 หรือ H4

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

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

ตัวอย่างข้อความเชื่อมต่อ:

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

ข้อความเชื่อมต่อเหล่านี้ช่วยให้ผู้อ่านเข้าใจบริบทและทำให้คู่มือไหลลื่น จำไว้ว่าคุณควรใช้ประโยคในรูปแบบบุรุษที่สอง (เช่น "คุณจะสร้าง") แทนบุรุษที่หนึ่งเมื่อเขียนเนื้อหาและข้อความเชื่อมต่อ

บทสรุป​

ส่วนสุดท้ายคือบทสรุปของคู่มือ ควรสรุปใน 1-3 ประโยค อธิบายว่าผู้อ่านทำอะไรสำเร็จ และแนะนำแหล่งข้อมูลเพิ่มเติมหรือคู่มือที่สามารถติดตามเพื่อขยายความรู้ในหัวข้อนั้น

ควรลิงก์ไปยังคู่มือ ZAP-Docs ที่มีอยู่ โดยเฉพาะคู่มือที่ต่อเนื่องจากคู่มือของคุณ และแนะนำให้ติดต่อทีมซัพพอร์ตหากผู้อ่านยังมีปัญหา

ตัวอย่างบทสรุปที่ดีคือ:

คุณได้ตั้งค่าซอฟต์แวร์ให้ทำงานบนเซิร์ฟเวอร์ Linux ของคุณเรียบร้อยแล้ว! เราแนะนำให้ดูคู่มือบริการ Linux ในส่วนนี้เพื่อเรียนรู้การติดตั้งบริการเพิ่มเติม

หากมีคำถามหรือขอความช่วยเหลือเพิ่มเติม อย่าลังเลที่จะติดต่อทีมซัพพอร์ตของเรา ซึ่งพร้อมให้บริการทุกวันเพื่อช่วยเหลือคุณ! 🙂

สไตล์​

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

เชิงเทคนิค & ถูกต้อง​

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

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

เคล็ดลับ

เราแนะนำให้ผู้เขียนตรวจสอบการสะกดและไวยากรณ์ด้วยเครื่องมือตรวจสอบคำสะกดก่อนส่งคำขอดึงข้อมูล เว็บไซต์ที่แนะนำคือ: https://languagetool.org/

ใช้งานได้จริง & มีประโยชน์​

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

เป็นมิตร, เป็นทางการ & ครอบคลุม​

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

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

สุดท้าย ผู้เขียนทุกคนต้องปฏิบัติตามจรรยาบรรณของเรา เพื่อให้คู่มือยอมรับทุกคนโดยไม่คำนึงถึงอายุ เชื้อชาติ เพศ ระดับประสบการณ์ สัญชาติ ศาสนา ความเชื่อทางการเมือง รสนิยมทางเพศ สถานะทางสังคม-เศรษฐกิจ หรือทางเลือกเทคโนโลยี หลีกเลี่ยงภาษาที่อาจก่อให้เกิดความไม่เหมาะสมหรือเนื้อหาที่เกี่ยวข้องกับหัวข้อเหล่านี้

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

เอกสารของเราใช้ภาษา Markdown ซึ่งเป็นที่นิยมและใช้งานง่าย ไปดูส่วนด้านล่างเพื่อเข้าใจว่ามีอะไรบ้างและใช้อย่างไร

เคล็ดลับ

สำหรับตัวอย่างเพิ่มเติมและคำอธิบาย Markdown แบบละเอียด ไปที่ Markdown Guide ซึ่งมีข้อมูลเพิ่มเติม

หัวข้อ​

หัวข้อเป็นตัวเลือกการจัดรูปแบบที่สำคัญที่สุดในการแยกเนื้อหาอย่างครอบคลุมและมีตรรกะ ชื่อหลักคือหัวข้อ H1 แต่คุณไม่ควรใช้ในเนื้อหาโดยตรง ให้ใช้ title metadata ด้านบนของไฟล์คู่มือแทน

ในคู่มือของเรา หัวข้อ H2 ใช้แบ่งส่วนหลักของคู่มือ ตามด้วยหัวข้อ H3 เพื่อแบ่งส่วนหลักเป็นหัวข้อย่อย เช่น แบ่งส่วนหลักเป็นหลายขั้นตอนเพื่อให้ง่ายต่อการทำตาม และยังมีหัวข้อ H4 ที่ใช้ไม่บ่อยนัก แต่มีไว้แบ่งหัวข้อย่อยอีกระดับโดยไม่แสดงในโครงสร้างคู่มือ

ข้อมูล

ถ้าใช้หัวข้อย่อย (เช่น H3 ภายใต้ H2) โปรดตรวจสอบว่ามีหัวข้อย่อยอย่างน้อยสองหัวข้อในส่วนเดียวกัน มิฉะนั้นถือว่าใช้ไม่ถูกต้อง

ตัวอย่างการใช้หัวข้อ:

## Installation
H2 - ส่วนหลัก

### Downloading Game Files
H3 - หัวข้อย่อยของ H2

#### Via SteamCMD
H4 - หัวข้อย่อยของ H3

#### Manually via GitHub
H4 - หัวข้อย่อยของ H3

### Preparing Configuration
H3 - หัวข้อย่อยของ H2

### Starting Server
H3 - หัวข้อย่อยของ H2

Markdown แบบฝังในบรรทัด​

เราใช้การจัดรูปแบบหลายแบบเพื่อเพิ่มความอ่านง่ายและเหมาะกับผู้อ่านที่มีทักษะทางเทคนิคหลากหลาย อ่านต่อเพื่อเข้าใจการใช้งานแต่ละแบบ

ตัวหนา​

ใช้เน้นข้อมูลสำคัญ เช่น

  • เปลี่ยนบริบทระหว่างขั้นตอน
  • โฮสต์เนม, ข้อมูลล็อกอิน & ชื่อผู้ใช้
  • คำศัพท์สำคัญ

ใช้เครื่องหมายดอกจันคู่ล้อมรอบข้อความ เช่น **hello there** จะได้ hello there

ตัวเอียง​

ใช้แนะนำคำศัพท์เทคนิคใหม่ เช่น เราจะตั้งค่า reverse proxy วันนี้

ใช้เครื่องหมายดอกจันเดี่ยวล้อมรอบข้อความ เช่น *ZAP-Hosting - More POWER!* จะได้ ZAP-Hosting - More Power!

โค้ดในบรรทัด​

ใช้แสดงข้อมูลเทคนิค เช่น URL ตัวอย่าง:

  • ชื่อไฟล์และเส้นทาง (เช่น C:/User/[your_name]/AppData....test.png)
  • URL (เช่น https://zap-hosting.com)
  • พอร์ต (เช่น :30120)
  • คำสั่ง (เช่น ipconfig)
  • คำสั่ง SQL (เช่น SELECT * FROM servers)
  • ปุ่มกด (เช่น ENTER หรือ CTRL + C)

ตาราง​

มีประโยชน์เมื่อแสดงข้อมูลซ้ำๆ เช่น คำสั่ง คำอธิบาย และการใช้งาน ตัวอย่าง:

| Command     | Description              | Usage                 |
| ----------- | ------------------------ | --------------------- |
| /help       | ส่งคำสั่งช่วยเหลือ      | /help [category]      |
| /stop       | หยุดเซิร์ฟเวอร์          | /stop [true/false]    |

บล็อกโค้ด​

มีประโยชน์สำหรับคู่มือที่ใช้คำสั่ง สคริปต์ หรือผลลัพธ์เทอร์มินัล

ใช้เครื่องหมาย ``` ล้อมรอบข้อความที่ต้องการ เช่น

function hello(name) {
    console.log(name)
}

var server = "ZAP-Hosting"
hello(server)

การใช้กล่องข้อความ (admonitions)​

คุณอาจใช้กล่องข้อความเพื่อเน้นข้อมูลภายใต้ 5 ป้ายชื่อที่มีดังนี้

รูปแบบการใช้เหมือนกัน แค่เปลี่ยนคำสำคัญ เช่น:

:::note
นี่คือโน้ต! เปลี่ยนคำสำคัญด้านบนเพื่อเปลี่ยนประเภทกล่องข้อความ
:::

โน้ต​

Note Title! (ไม่บังคับ)

ใช้แสดงโน้ตเพิ่มเติมที่อาจมีประโยชน์แต่ไม่สำคัญโดยตรง

เคล็ดลับ​

Tip Title! (ไม่บังคับ)

ใส่เคล็ดลับจากประสบการณ์ของคุณในกล่องนี้

ข้อมูล​

Info Title! (ไม่บังคับ)

ถ้ามีข้อมูลสำคัญที่ผู้ใช้ควรรู้ ให้ใส่ในกล่องนี้

ระวัง​

Caution Title! (ไม่บังคับ)

ถ้ามีสิ่งที่ผู้ใช้ควรระวังขณะทำตามคู่มือ ให้ใช้กล่องนี้เน้น

อันตราย​

Danger Title! (ไม่บังคับ)

ใช้กล่องนี้สำหรับข้อมูลสำคัญที่ต้องเน้น เช่น บั๊กที่รู้จักหรือฟีเจอร์ที่เลิกใช้แล้ว

ภาพหน้าจอ​

ภาพหน้าจอช่วยแนะนำผู้อ่านผ่านขั้นตอนต่างๆ ด้วยภาพ เราแนะนำให้ใช้เมื่อเหมาะสม

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

ใช้ไวยากรณ์นี้เพื่อเพิ่มภาพหน้าจอ โดยแทนที่ your_url ด้วย URL ของภาพ:

![](your_url)

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

คำศัพท์​

ในเอกสารของเราจะมีคำศัพท์สำคัญหลากหลาย เราคาดหวังให้ใช้การสะกดแบบ US-English เพื่อความสม่ำเสมอ ในส่วนนี้เราจะกำหนดคำศัพท์ที่ใช้บ่อย

ผลิตภัณฑ์ ZAP-Hosting​

เมื่ออ้างอิงผลิตภัณฑ์ของ ZAP-Hosting ให้แน่ใจว่าใช้ชื่อ การสะกด และตัวพิมพ์ใหญ่ถูกต้อง ตรวจสอบได้ที่ เว็บไซต์ ZAP-Hosting และดูว่าผลิตภัณฑ์นั้นถูกอ้างอิงอย่างไรในหน้าผลิตภัณฑ์

แอตทริบิวต์ที่ผู้ใช้กำหนดเอง​

ในคู่มือส่วนใหญ่ ตัวเลือกการตั้งค่าสำหรับผู้ใช้ เช่น ชื่อผู้ใช้ โฮสต์เนม โดเมน ที่อยู่ IP และ URL จะต้องใช้ข้อมูลของผู้อ่านแทนที่ตัวอย่าง

โดยปกติให้ใช้รูปแบบ [your_attribute] เพื่อแยกความแตกต่างระหว่างองค์ประกอบคงที่กับองค์ประกอบเฉพาะ เช่น ถ้าเป็น IP ให้ใช้ [your_server_ip] หรือถ้าเป็น URL ให้ใช้ http://[your_server_ip]:30120 เพื่อให้ชัดเจนว่าผู้อ่านต้องเปลี่ยนค่าเหล่านี้ตามการตั้งค่าของตัวเอง ควรอธิบายหรือแจ้งให้ผู้อ่านทราบว่าต้องเปลี่ยนแอตทริบิวต์ใดบ้างเมื่อกล่าวถึงครั้งแรกเพื่อความเข้าใจ

ใช้ zaphosting เป็นค่าเริ่มต้นสำหรับโฮสต์เนม ชื่อผู้ใช้ หรือชื่อฐานข้อมูล

ซอฟต์แวร์​

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

ควรลิงก์ไปยังเว็บไซต์ทางการของซอฟต์แวร์เมื่อกล่าวถึงครั้งแรกและถ้ามีเว็บไซต์อย่างเป็นทางการ

Cookie settings