เอกสารเกี่ยวกับปลั๊กอินและธีมของ WordPress

เอกสารเป็นสิ่งที่มักจะชื่นชมเมื่อมีปัญหาเท่านั้นและคุณต้องการคำตอบอย่างรวดเร็ว ในบทความนี้ เราจะอธิบายสาเหตุที่การเขียนเอกสารสำหรับเนื้อหา WordPress ของคุณมีความสำคัญต่อการปฏิบัติของคุณในฐานะนักพัฒนา WordPress และคุณภาพของธีมและปลั๊กอินที่คุณจัดส่ง

เหตุใดเอกสารจึงมีความสำคัญ

การรักษาชุดเอกสารที่อัปเดตเกี่ยวกับโครงการ ทรัพย์สิน หรือผลิตภัณฑ์ของคุณเป็นสิ่งสำคัญด้วยเหตุผลหลายประการ

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

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

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

หลักการ 5 ข้อสำหรับเอกสารที่มีประสิทธิภาพ

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

มาดู 5 สิ่งที่สำคัญที่สุดกัน เพื่อให้คุณสามารถเขียนเอกสารที่มีประสิทธิภาพสำหรับผลิตภัณฑ์ของคุณ!

• ชอบใช้คำน้อยกว่าปกติในการเขียนของคุณ: ทุกคำควรมีจุดประสงค์ ตรงไปตรงมาและเรียบง่าย โดยปกติแล้วจะมีการขอเอกสารเมื่อบุคคลมีปัญหาและต้องการหาวิธีแก้ไขอย่างรวดเร็ว ตัวอย่างเช่น ประโยคเช่น "ความล้มเหลวในการทำลาย Object Q จะ ทำให้เกิดการรั่วไหลของหน่วยความจำ" จะดีกว่า "ความล้มเหลวในการทำลาย Object Q จะทำให้เกิดการรั่วไหลของ หน่วยความจำ"
• ต้องการใช้เสียงที่ใช้งานแทน passive: “ คลิก ปุ่มที่ด้านบนขวา” แทน “ ต้อง คลิกปุ่มที่ด้านบนขวา” การใช้เสียงพูดช่วยขจัดความคลุมเครือว่าใครทำอะไร Passive Voice จะใช้เฉพาะเมื่อคุณต้องการโฟกัสที่วัตถุ แทนที่จะใช้ที่วัตถุ (เช่น Pressidium's Platform สร้างขึ้นโดยคำนึงถึงความ ปลอดภัย )
• ใช้ภาษาอธิบายเมื่อคุณต้องการอธิบายแนวคิด และจำเป็นเมื่อคุณต้องการอธิบายขั้นตอนทีละขั้นตอน (เช่น บทช่วยสอน)
• ใช้รายการสัญลักษณ์แสดงหัวข้อย่อยเมื่อคุณต้องการแสดงรายการที่ไม่มีลำดับ และใช้รายการลำดับเลขเมื่อลำดับของคะแนนมีความสำคัญ
• ตรวจสอบให้แน่ใจว่าคุณได้ทดสอบคำแนะนำด้วยตัวเองก่อนที่จะนำเสนอ!

เอกสารปลั๊กอิน WordPress

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

โฮสต์เว็บไซต์ของคุณด้วย Pressidium

รับประกันคืนเงิน 60 วัน

ดูแผนของเรา

การเผยแพร่ปลั๊กอิน WordPress ของคุณบน wordpress.org จะทำให้คุณมีที่สำหรับใส่คำแนะนำในการติดตั้ง ภาพหน้าจอ คำถามที่พบบ่อย แม้กระทั่งบันทึกการเปลี่ยนแปลง! การกรอกข้อมูลที่เป็นประโยชน์และมีคุณภาพเป็นกุญแจสำคัญในการทำให้ปลั๊กอินของคุณเป็นที่นิยมมากขึ้น:

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

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

การจัดทำเอกสารธีม WordPress

การจัดทำเอกสารธีม WordPress เป็นเรื่องที่แตกต่างอย่างสิ้นเชิง ปัญหาที่พบบ่อยที่สุดเกี่ยวกับธีม WordPress คือการไม่รู้ว่าส่วนใดสอดคล้องกับองค์ประกอบภาพใด ไม่ใช่ทุกคนที่พูด CSS ได้คล่อง:

• สร้างลำดับชั้นของทุกส่วนของ CSS พร้อมคำอธิบายที่เกี่ยวข้อง
• สำหรับแต่ละส่วน ให้เพิ่มภาพหน้าจอที่มีคำอธิบายประกอบซึ่งมีรายละเอียดการทำงานแต่ละอย่าง พร้อมด้วยตัวอย่างเล็กๆ อย่าลืมใช้เสียงพูดและภาษาที่จำเป็นเมื่อแสดงวิธีการทำบางสิ่งที่ผู้ใช้ต้องปฏิบัติตามคำแนะนำ
• ใช้เครื่องมือเช่น css_doc เพื่อช่วยคุณ สิ่งนี้จะสร้างเอกสารสไตล์ JavaDoc และสามารถเผยแพร่ได้
• บางครั้งความคิดเห็นเกี่ยวกับโค้ดยังไม่เพียงพอ และคุณจำเป็นต้องสร้างเอกสารคู่มือสไตล์สำหรับธีม CSS ของคุณ เอกสารแนะนำรูปแบบจะอธิบายว่าองค์ประกอบต่างๆ จำเป็นต้องมีลักษณะอย่างไร และต้องใช้ในกรณีใดบ้าง พวกเขาบังคับใช้ความสม่ำเสมอและทำให้การทำงานร่วมกันง่ายขึ้นเช่นกัน ดูตัวอย่างนี้โดย Google
• ใช้เฟรมเวิร์ก CSS เช่น Blueprint CSS สิ่งนี้จะช่วยคุณในการพัฒนาโดยมอบชุดเครื่องมือให้คุณ เช่น ตารางที่ปรับแต่งได้ ตัวพิมพ์เริ่มต้นที่ใช้งานได้ การรีเซ็ต CSS ของเบราว์เซอร์ และอื่นๆ อีกมากมาย
• อีกครั้งอย่าลืมปรึกษามาตรฐานการเข้ารหัส WordPress CSS อย่างเป็นทางการ