หน้านี้มีรายละเอียดของโครงการเขียนเชิงเทคนิคที่ยอมรับใน Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- Matic
- ผู้เขียนด้านเทคนิค:
- สวาติ Thacker
- ชื่อโปรเจ็กต์:
- ตรวจสอบและอัปเดตเอกสารสำหรับผู้ใช้ปลายทางสำหรับ Mautic
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
ความประทับใจแรกเมื่ออ่านเอกสารที่มีอยู่
ปัจจุบันเอกสารมีขนาดยาว ซ้ำซ้อนในหลายๆ ส่วน ไม่สมบูรณ์ และเป็นระเบียบ ซึ่งอาจทำให้ผู้ใช้ค้นหาข้อมูลที่ต้องการได้ยาก
ในฐานะผู้ใช้ครั้งแรก ผมไม่เข้าใจเลยว่าองค์ประกอบต่างๆ ของ Mautic อย่างแคมเปญ ชิ้นงาน ข้อความ หมวดหมู่ และอื่นๆ จะทำงานร่วมกันเพื่อตอบสนองความต้องการทางธุรกิจได้อย่างไร เราขอเสนอหัวข้อแนวคิดระดับสูงที่อธิบายถึงองค์ประกอบ Mautic แต่ละรายการใน 2-3 บรรทัด หัวข้อนี้อาจลิงก์ไปยังหัวข้องานโดยละเอียดเกี่ยวกับองค์ประกอบแต่ละอย่างเหล่านี้
คู่มือการมีส่วนร่วมสามารถขยายได้เพื่อให้ข้อมูลเพิ่มเติม เช่น วิธีเปิดปัญหา วิธีแนะนำเนื้อหา/แนวคิดใหม่ รายงานข้อบกพร่อง/ปัญหา/ช่องโหว่ด้านความปลอดภัย ฯลฯ ด้วยการให้ลิงก์ไปยังฟอรัม ช่อง Slack และที่เก็บ Git นอกจากนี้ คู่มือสไตล์การเขียนยังต้องขยายออกเพื่อเพิ่มรูปแบบมาตรฐานของการพิมพ์ หลักเกณฑ์สำหรับรูปภาพ ตาราง ฯลฯ
นอกจากนี้ ยังมีข้อมูลค่อนข้างไม่สมบูรณ์ในอีเมล แคมเปญ และข้อมูลเก่า/ล้าสมัยที่จำเป็นต้องอัปเดต
ส่วนที่ฉันต้องการมีส่วนร่วม
ระหว่างการพูดคุยในช่องทาง Slack ที่ผู้ใช้โต้ตอบกับชุมชน Mautic โดยตรง ผมได้ตระหนักว่าแคมเปญและอีเมลคือองค์ประกอบสำคัญของ Mautic ผมได้ทดสอบเอกสารประกอบเกี่ยวกับแคมเปญใน Mautibox เวอร์ชัน 3 และพบว่าต้องปรับโฉมครั้งใหญ่ ต่อไปนี้คือปัญหาบางส่วนที่ฉันพบและข้อเสนอของฉันสำหรับแต่ละปัญหา
- ผู้ใช้ Mautic สามารถเลือกการดำเนินการ การตัดสินใจ และเงื่อนไขได้หลากหลายขณะสร้างแคมเปญ ไม่มีเอกสารประกอบสำหรับการดำเนินการและการตัดสินใจจำนวนมาก ในขณะที่แทบไม่มีเอกสารประกอบสำหรับเงื่อนไขของแคมเปญ เราจำเป็นต้องระบุและเพิ่มข้อมูลที่ขาดหายไปลงในเอกสารของผู้ใช้ปลายทาง
- แคมเปญอาจเรียบง่ายหรือซับซ้อนมาก เอกสารประกอบปัจจุบันไม่ได้เพิ่มคุณค่ามากนักให้กับผู้ใช้ที่สร้างแคมเปญเป็นครั้งแรก ฉันจะเสนอให้ระบุกรณีการใช้งานบางส่วน (ทั้งง่ายและซับซ้อน) และสร้างตัวอย่างเวิร์กโฟลว์ (ในรูปแบบของบทแนะนำทีละขั้นตอน หรือหัวข้อในคู่มือผู้ใช้ปลายทางหรือวิดีโอแสดงวิธีการ) ที่ผู้ใช้ครั้งแรกสามารถอ้างถึงได้ก่อนที่จะเริ่มสร้างแคมเปญของตนเอง
- ข้อมูลจำเป็นต้องมีการนำเสนอในรูปแบบที่เป็นระเบียบและเป็นระเบียบมากขึ้นในส่วนนี้ ต้องปฏิบัติตามแนวทางของงานและแนวคิดเพื่อเพิ่มความสามารถในการใช้งาน หัวข้อจะใช้ตารางเพื่อนำเสนอข้อมูลเกี่ยวกับการดำเนินการ การตัดสินใจ และเงื่อนไขต่างๆ ได้ หัวข้อ "การใช้ทริกเกอร์วันที่" อาจดูแปลกไปเล็กน้อย ซึ่งฝังได้ในส่วนเงื่อนไข
นอกจากเรื่องแคมเปญแล้ว ผมยังทดสอบเอกสารประกอบสำหรับอีเมลเทียบกับ UI ด้วย สิ่งที่เราเสนอให้ดำเนินการมีดังนี้
- เนื้อหาแบบไดนามิกสำหรับอีเมลใช้ได้กับเทมเพลตอีเมลโค้ดที่กำหนดเอง (ทั้งอีเมลเทมเพลตและอีเมลกลุ่ม) แต่ขณะนี้ยังไม่มีเอกสารประกอบ เพิ่มรายละเอียดเกี่ยวกับการทำงานของเนื้อหาแบบไดนามิก และวิธีตั้งค่า รวมถึงตัวอย่าง 2-3 รายการ
- เพิ่มหัวข้อแยกต่างหากสำหรับอีเมล Monitoring ซึ่งอาจรวมถึงข้อมูลเกี่ยวกับการใช้วิดเจ็ตอีเมลที่มีอยู่ในหน้าแดชบอร์ด และวิธีการใช้วิดเจ็ตเพื่อติดตามเมตริกและกิจกรรมที่เกี่ยวข้องกับอีเมล นอกจากนี้ ย้ายข้อมูลเกี่ยวกับการติดตามอีเมลมาที่นี่
- เอกสารประกอบไม่ได้ระบุอย่างชัดเจนว่าการตอบกลับรายชื่อติดต่อ การจัดการการตีกลับ จดหมายแจ้งเป็นเจ้าของ คือการตั้งค่าส่วนกลางที่สามารถกำหนดค่าได้ในส่วนการตั้งค่าอีเมล การตั้งค่าอีเมลทั้งหมดควรอยู่ในหัวข้อที่ครอบคลุม นอกจากนี้ การตั้งค่าอีเมลอื่นๆ อีกมากมาย เช่น กฎความถี่เริ่มต้น การตั้งค่าการยกเลิกการรับข่าวสารจะไม่มีการจัดทำเอกสารไว้เลย อธิบายว่าการตั้งค่าใดบังคับหรือไม่บังคับ
- จากหน้าการจัดการการตีกลับ ให้นำข้อมูลทั้งหมดเกี่ยวกับเว็บฮุคออก แล้ววางไว้ในหัวข้อที่แยกต่างหากสําหรับเว็บฮุค จากนั้นเราจะให้ลิงก์ไปยังหัวข้อดังกล่าวจากที่นี่
นอกจากนี้ - หัวข้อหน้าแดชบอร์ดมีข้อมูลที่ไม่สมบูรณ์เกี่ยวกับวิดเจ็ตที่พร้อมใช้งาน ข้อมูลนี้มีความสำคัญและจำเป็นต้องเพิ่มเนื่องจากช่วยให้ผู้ใช้วิเคราะห์และตรวจสอบทรัพยากร Mautic ของตนได้
ต้องจัดเก็บเอกสารทั้งหมดไว้เพื่อหาช่องว่าง เราต้องปรับปรุงในเรื่องเพื่อให้ผู้ใช้สามารถเข้าถึงเอกสารได้มากขึ้น
ฉันจะคาดหวังว่าความรู้/ประสบการณ์ของฉันจะเป็นประโยชน์ต่อโปรเจ็กต์นี้ได้อย่างไร
หลังจากพยายามแก้ไขปัญหาต่างๆ ในเอกสารของ Mautic รวมถึงเพิ่มการสนับสนุนสำหรับ Mautic 3.0 รุ่นล่าสุดในช่วงเดือนที่ผ่านมา ผมได้ทำความคุ้นเคยกับโครงสร้างของเอกสารของผู้ใช้ปลายทาง ตลอดจนระบุช่องว่างในเอกสารประกอบ ผมได้ใช้เวลาศึกษาเอกสารสำหรับเครื่องมือทางการตลาดอัตโนมัติอื่นๆ และเปรียบเทียบกับเอกสารสำหรับผู้ใช้ปลายทางของ Mautic เพื่อทำความเข้าใจวิธีที่เราจะช่วยเติมเต็มช่องว่างเหล่านั้นในเอกสารประกอบของเรา ผมคุ้นเคยกับภาษา HTML, เครื่องมือโอเพนซอร์ส และกระบวนการต่างๆ ถือเป็นข้อได้เปรียบที่เพิ่มขึ้น ตอนนี้ฉันกำลังศึกษาหลักสูตรด้านการวิจัยประสบการณ์ของผู้ใช้ และสามารถใช้หลักการดังกล่าวเพื่อสร้างเอกสารประกอบที่มุ่งเน้นผู้ใช้มากขึ้น นอกจากนี้ ประสบการณ์ด้านสถาปัตยกรรมข้อมูลทำให้ฉันสามารถจัดระเบียบเนื้อหาและเสนอไอเดียในการปรับเอกสารของเราให้สอดคล้องกับเป้าหมายของผู้ใช้ นอกจากนี้ ฉันยังมีทักษะความรู้ความเชี่ยวชาญที่เพิ่มขึ้นเกี่ยวกับโดเมนทางเทคนิคใหม่ๆ อีกด้วย จากประสบการณ์การเขียนเชิงเทคนิคเป็นระยะเวลา 10 ปีและประสบการณ์การใช้งาน GSOD ก่อนหน้านี้จากความสำเร็จของโปรเจ็กต์สำหรับองค์กรในโดเมนทางเทคนิคที่ยังใหม่มากสำหรับฉัน ฉันมั่นใจว่าฉันมีความยุติธรรมต่อการมีส่วนร่วมในเอกสารประกอบของ Mautic