หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- เมาติก
- นักเขียนเชิงเทคนิค:
- Favour Kelvin
- ชื่อโปรเจ็กต์:
- Knowledgebase
- ระยะเวลาของโปรเจ็กต์
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
บทคัดย่อ
ฐานความรู้เป็นที่เก็บข้อมูลแบบรวมศูนย์ที่จัดเก็บ จัดการ และแชร์ข้อมูล เมื่อใช้ภายนอก ฐานความรู้คือที่ที่ผู้ใช้สามารถเข้าไปดูข้อมูลทั้งหมดที่ต้องการเกี่ยวกับผลิตภัณฑ์หรือบริการ องค์กร และอุตสาหกรรมของบริษัท ในทางกลับกัน ฐานความรู้ภายในมักจะใช้เพื่อให้ชุมชน/ผู้ใช้ทำงานร่วมกันและเผยแพร่ความรู้และข้อมูลของบริษัททั้งหมดภายในบริษัท แม้ว่าเนื้อหาของฐานความรู้หนึ่งๆ จะแตกต่างกันไปตามปัจจัยหลายประการ แต่ส่วนใหญ่มักมีข้อมูลเกี่ยวกับวิธีเริ่มต้นใช้งานผลิตภัณฑ์ที่เจาะจง วิธีใช้ฟีเจอร์ขั้นสูงให้ได้ประโยชน์มากขึ้น ตลอดจนแก้ไขปัญหาหรือปัญหาที่พบได้ทั่วไป ประโยชน์หลักของการสร้างและนำเสนอฐานความรู้แก่ผู้ชมคือ การช่วยให้คุณมอบข้อมูลเชิงลึกแบบออนดีมานด์อย่างเจาะลึก ทันที และคำตอบให้กับสมาชิก/ผู้ใช้/ชุมชนของกลุ่มเป้าหมายโดยไม่จำเป็นต้องทำเช่นนั้นทีละรายการ
ฐานความรู้ของ Mautic เป็นที่เก็บส่วนกลางสำหรับบทแนะนำ คำแนะนำวิธีใช้ และแนวทางปฏิบัติแนะนำเกี่ยวกับหัวข้อที่เกี่ยวข้องกับ Mautic ไม่ว่าจะโดยตรง (เช่น วิธีทำสิ่งต่างๆ ใน Mautic) หรือโดยอ้อม (เช่น กลยุทธ์การตลาดทั่วไป)
ขณะเขียนบทความนี้ ฐานความรู้ของ Mautic ค่อนข้างใหม่และไม่สมบูรณ์ และชุมชน Mautic ต้องการใช้โปรเจ็กต์นี้เพื่อปรับปรุงวิธีให้ข้อมูลเชิงลึกและข้อมูลตามคําขอในเอกสารประกอบของผู้ใช้ เพื่อให้ผู้ใช้ปลายทางได้รับประสบการณ์การใช้งาน Mautic ที่ราบรื่น การศึกษาฐานความรู้ของ Mautic ให้ข้อมูลมากพอสมควร แต่จำเป็นต้องมีบทแนะนำและคู่มือวิธีการที่อัปเดต รวมถึงการสร้างบทแนะนำและคู่มือวิธีการใหม่ให้สอดคล้องกับ Mautic เวอร์ชัน 3x
ความคิดเห็นแรกเมื่ออ่านเอกสารประกอบที่มีอยู่ ปัจจุบันฐานความรู้ของ Mautic พร้อมให้บริการที่ https://kb.mautic.org/ บทแนะนําและคู่มือวิธีการและหัวข้อแนวทางปฏิบัติแนะนําบางส่วนในเอกสารประกอบไม่เป็นปัจจุบัน กระจัดกระจายหรือไม่สมบูรณ์ และไม่มีข้อมูลเกี่ยวกับ Mautic เวอร์ชันปัจจุบัน
เหตุใดการปรับปรุงที่คุณเสนอจึงดีกว่าการปรับปรุงปัจจุบัน/ด้านที่เราอยากมีส่วนร่วม การปรับปรุงที่เสนอจะมุ่งเน้นที่การปรับปรุงและรับประกันประสิทธิภาพ ความสอดคล้อง และความสงบของผู้ใช้ปลายทาง คู่มือนี้จะมีบทแนะนำที่เป็นลายลักษณ์อักษร คำแนะนำวิธีการ และแนวทางปฏิบัติที่ดีที่สุด และรูปภาพที่เกี่ยวข้อง คำแนะนำและคำอธิบายเกี่ยวกับวิธีการใช้คุณลักษณะต่างๆ ของแอปนั้นๆ ให้เป็นข้อมูลล่าสุด ใช้งานง่าย และเข้าใจได้ง่าย
การวิเคราะห์
ฐานความรู้ของ Mautic เขียนขึ้นใน CMS ไฟล์ Grav แบบไฟล์เดี่ยวและธีม KLB4 เราได้ค้นคว้าวิธีปรับปรุงเอกสารประกอบในฐานความรู้อย่างละเอียด
เป้าหมายโปรเจ็กต์
- ตรวจสอบฐานความรู้
- อัปเดตบทแนะนำและคู่มือการใช้งานให้เหมาะกับ Mautic เวอร์ชัน 3x
- สร้างทรัพยากรสำหรับฐานความรู้ของชุมชน Mautic ที่สร้างขึ้นใหม่
- เขียนชุดบทแนะนำและคู่มือที่จะช่วยผู้ใช้ Mautic ตั้งค่า กำหนดค่า และใช้แอปพลิเคชันได้อย่างมีประสิทธิภาพมากขึ้น
- อัปเดตวิดีโอแนะนําให้เหมาะกับ Mautic เวอร์ชัน 3x
- นำรูปภาพและข้อมูลที่ล้าสมัยออก
- เขียนฐานความรู้ใหม่ให้เข้าใจง่ายขึ้น
- ตรวจสอบการใช้คู่มือสไตล์/รูปแบบของเอกสารประกอบในฐานความรู้อย่างเหมาะสม
ไทม์ไลน์
ก่อนวันที่ 1 สิงหาคม
- มีส่วนร่วมกับองค์กรต่อไป
- ทำความคุ้นเคยกับเอกสารประกอบในฐานความรู้และ Mautic เวอร์ชันปัจจุบันมากขึ้น
- เรียนรู้เทคนิคใหม่ๆ และทักษะการเขียนเชิงเทคนิคซึ่งจะเป็นประโยชน์ขณะใช้งานโปรเจ็กต์
การสานสัมพันธ์ในชุมชน (1 สิงหาคม - 1 กันยายน)
- ตั้งค่าช่องทางการสื่อสารและเวลา (เนื่องจากความแตกต่างของเขตเวลา)
- ปรับแต่งเป้าหมายและกำหนดความคาดหวังของทั้ง 2 ฝ่าย
- ดูข้อมูลเพิ่มเติมเกี่ยวกับชุมชนและผลิตภัณฑ์
- พูดคุยเกี่ยวกับโครงสร้างเอกสารที่เสนอกับที่ปรึกษาและสมาชิกคนอื่นๆ ในองค์กร
- สรุปฟีเจอร์ที่เสนอและการแก้ไขอื่นๆ ที่จำเป็นในเอกสารประกอบที่มีอยู่
ระยะเวลาการจัดทำเอกสาร
- สัปดาห์ที่ 1 (2 กันยายน - 22 พฤศจิกายน)
- ในระหว่างนี้ ฉันจะทํางานร่วมกับที่ปรึกษาโดยตรงเพื่อดำเนินการต่อไปนี้
- ตรวจสอบฐานความรู้
- อัปเดตบทแนะนำและคู่มือการใช้งานให้เหมาะกับ Mautic เวอร์ชัน 3x
- สร้างทรัพยากรสำหรับฐานความรู้ของชุมชน Mautic ที่สร้างขึ้นใหม่
- เขียนชุดบทแนะนำและคู่มือที่จะช่วยผู้ใช้ Mautic ตั้งค่า กำหนดค่า และใช้แอปพลิเคชันได้อย่างมีประสิทธิภาพมากขึ้น
- อัปเดตวิดีโอแนะนําให้เหมาะกับ Mautic เวอร์ชัน 3x
- นำรูปภาพและข้อมูลที่ล้าสมัยออก
- เขียนฐานความรู้ใหม่ให้เข้าใจง่ายขึ้น
- ตรวจสอบว่าได้ใช้คู่มือ/รูปแบบของเอกสารประกอบในฐานความรู้อย่างถูกต้อง
- พิจารณาความถี่ในการเผยแพร่เนื่องจากทีมพัฒนาจะยุ่งอยู่กับการเผยแพร่ฟีเจอร์ย่อย
การประเมินโปรเจ็กต์ (25-29 พฤศจิกายน 2019)
- ส่งรายงานโปรเจ็กต์และการประเมินโดยที่ปรึกษา
- เขียนและส่งรายงานเกี่ยวกับประสบการณ์ของฉันในฐานะผู้เข้าร่วมใน Season of Docs