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