หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- Mautic
- ผู้เขียนด้านเทคนิค:
- Swati 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