เอกสารผลิตภัณฑ์สำหรับมืออาชีพ WordPress

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

แต่สิ่งนี้เปลี่ยนไป:

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

เหตุใดผู้เชี่ยวชาญ WordPress จึงควรใส่ใจเกี่ยวกับเอกสารประกอบผลิตภัณฑ์

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

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

1. คุณใส่ใจในรายละเอียด
2. คุณใส่ใจลูกค้าของคุณมากพอที่จะก้าวไปอีกขั้น
3. คุณมีความโปร่งใสและมั่นใจเกี่ยวกับการออกแบบและการตัดสินใจโครงการด้านเทคนิคของคุณ

Mike Puterbaugh รองประธานฝ่ายการตลาดของ MindTouch เขียนบทความ Mashable ที่อธิบายถึงเหตุผล 5 ประการที่เอกสารประกอบผลิตภัณฑ์ของคุณเป็นทรัพย์สินทางการตลาด เขาได้ข้อสรุปดังต่อไปนี้:

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

ตอนนี้เราได้สร้างแรงจูงใจเพียงพอแล้ว เราจะ:

1. สำรวจเอกสารผลิตภัณฑ์ประเภทต่างๆ ที่เกี่ยวข้องกับ WordPress
2. อภิปรายความต้องการของเอกสารแต่ละประเภทและให้คำแนะนำที่สามารถนำไปปฏิบัติได้
3. เสนอคำแนะนำเบื้องต้นเกี่ยวกับวิธีการวางแผนและทำงานร่วมกันในเอกสารผลิตภัณฑ์ โดยเฉพาะถ้าคุณทำงานที่เอเจนซี่ WordPress

ประเภทของเอกสารผลิตภัณฑ์ WordPress

ผลิตภัณฑ์ WordPress ไม่ได้เกี่ยวกับปลั๊กอินและธีมเท่านั้น ในส่วนนี้ เราจะพูดถึงความช่วยเหลือออนไลน์ REST API และสิ่งที่น่าสนใจที่เรียกว่าไมโครเนื้อหา

ปลั๊กอิน WordPress

เอกสารประกอบของปลั๊กอิน WordPress ต้องรองรับสองกลุ่ม: ผู้ใช้และนักพัฒนา ความต้องการด้านเอกสารของแต่ละคนแตกต่างกัน เช่นเดียวกับรูปแบบการเขียนที่ใช้

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

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

ดูแผนของเรา

ผู้ใช้

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

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

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

นักพัฒนา

นอกจากการปฏิบัติตามแนวทางปฏิบัติด้านซอฟต์แวร์ที่ดีที่สุดและมาตรฐานการเข้ารหัส PHP อย่างเป็นทางการแล้ว คุณควรให้ความสำคัญกับประเด็นต่อไปนี้:

ปลั๊กอินตะขอ

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

แท็กเทมเพลต

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

ตัวเลือก

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

ฐานข้อมูล

ปลั๊กอินมักอ่านและเขียนสิ่งต่างๆ มากมายจากฐานข้อมูล เนื่องจากสิ่งเหล่านี้เป็นการดำเนินการขั้นพื้นฐาน การบันทึกเอกสารเหล่านี้จะช่วยให้นักพัฒนารายอื่นเข้าใจวิธีการทำงานของปลั๊กอินอย่างมาก

ธีมเวิร์ดเพรส

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

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

อีกครั้งอย่าลืมปรึกษามาตรฐานการเข้ารหัส WordPress CSS อย่างเป็นทางการ

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

ความช่วยเหลือออนไลน์

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

Barry J. Rosenberg ผู้เขียน Spring into Technical Writing เสนอคำแนะนำต่อไปนี้เพื่อเขียนไฟล์ช่วยเหลือที่ดี:

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

ไมโครคอนเทนต์

Microcontent มีคำจำกัดความสองประการ: ความหมายแรกคือเนื้อหาเช่นพาดหัวข่าวและส่วนที่ผู้ใช้อ่านคร่าวๆ เพื่อให้ได้ส่วนสำคัญของบทความหนึ่งๆ ประการที่สองคือเนื้อหาเล็กน้อยที่สามารถยืนได้ด้วยตัวเองและใช้เพื่อปรับปรุงประสบการณ์ของผู้ใช้ ตัวอย่างที่ดีอย่างหนึ่งที่เรามีในใจคือบิต "หลายคนกำลังพิมพ์.." ของ Slack (แม้ว่า Slack จะเต็มไปด้วยเนื้อหาขนาดเล็กที่เขียนอย่างดีเยี่ยม)

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

REST API

การจัดทำเอกสาร REST API เป็นงานศิลปะที่แยกจากกันในตัวของมันเอง เช่นเดียวกับการเขียนเชิงเทคนิคทั้งหมด คุณควรมุ่งเป้าไปที่ความกระชับ ความชัดเจน และความเรียบง่ายในคำจำกัดความ เนื่องจาก REST API มีรูปแบบและความสลับซับซ้อนของตัวเอง คุณจึงไม่อาจทำได้แย่ไปกว่าการศึกษาคู่มือที่ยอดเยี่ยมในการจัดทำเอกสาร API โดย Tom Johnson ในบล็อก I'd Anything Be Writing

เอกสารการทำงานร่วมกันและการวางแผน

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

1. บันทึก ทุกสิ่ง ที่ผู้ใช้ต้องการทราบ รวมถึงพื้นที่ที่คุณจะต้องเขียนข้อความ
2. เมื่อคุณมีทุกอย่างแล้ว ให้จัดกลุ่มเป็นหมวดหมู่และตั้งชื่อเอกสาร
3. เขียน spec ของเอกสารแต่ละฉบับที่ลงรายละเอียดสิ่งต่างๆ เช่น ชื่อเรื่อง คำอธิบาย กลุ่มเป้าหมาย สื่อ (เอกสารจะมีรูปแบบใด) ความยาว เวลาที่ใช้ เป็นต้น
4. เพิ่มค่าประมาณจากข้อกำหนดเอกสารลงในการวางแผนโครงการของคุณ

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

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

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

ดูแผนของเรา

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

ปิด

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