หน้านี้มีรายละเอียดของโครงการเขียนเชิงเทคนิคที่ยอมรับใน Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- Matic
- ผู้เขียนด้านเทคนิค:
- สัมผัสเคลวิน
- ชื่อโปรเจ็กต์:
- ฐานความรู้
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
บทคัดย่อ
ฐานความรู้คือที่เก็บแบบรวมศูนย์ ซึ่งมีการจัดเก็บ จัดระเบียบ และแชร์ข้อมูล เมื่อใช้กับภายนอก ฐานความรู้คือที่ที่ผู้ใช้สามารถเรียนรู้ทุกสิ่งที่ต้องการเกี่ยวกับผลิตภัณฑ์หรือบริการ องค์กร และอุตสาหกรรมของบริษัท ในทางกลับกัน ฐานความรู้ภายในคือวิธีการที่จะช่วยให้ชุมชน/ผู้ใช้ทำงานร่วมกันและแจกจ่ายความรู้และข้อมูลทั้งหมดของบริษัทภายในองค์กร แม้ว่าเนื้อหาของฐานความรู้หนึ่งๆ จะแตกต่างกันไปตามปัจจัยต่างๆ แต่ส่วนใหญ่แล้วจะมีข้อมูลเกี่ยวกับวิธีเริ่มต้นใช้งานผลิตภัณฑ์ที่เฉพาะเจาะจง ใช้ประโยชน์จากฟีเจอร์ขั้นสูงต่างๆ มากขึ้น และเอาชนะปัญหาหรือปัญหาที่พบได้ทั่วไป ประโยชน์หลักของการสร้างและนำเสนอฐานความรู้แก่ผู้ชมคือช่วยให้คุณให้ข้อมูลที่เจาะลึก ทันท่วงที และตามคำขอ และคำตอบแก่สมาชิก/ผู้ใช้/ชุมชน โดยที่ไม่ต้องทำทีละรายการ
Mautic Knowledgebase เป็นที่เก็บส่วนกลางสำหรับบทแนะนำ คำแนะนำวิธีใช้ และแนวทางปฏิบัติแนะนำเกี่ยวกับหัวข้อที่เกี่ยวข้องกับ Mautic ทั้งทางตรง (เช่น วิธีทำสิ่งต่างๆ ใน Mautic) หรือโดยอ้อม (เช่น กลยุทธ์การตลาดทั่วไป)
ในขณะที่เขียนบทความนี้ Mautic Knowledgebase ยังใหม่และไม่สมบูรณ์ และชุมชน Mautic ต้องการใช้โครงการนี้เพื่อปรับปรุงวิธีการให้ข้อมูลที่เจาะลึกและตามความต้องการแก่เอกสารสำหรับผู้ใช้ เพื่อให้ผู้ใช้ปลายทางได้รับประสบการณ์ที่ราบรื่นเมื่อใช้ Mautic การดูฐานความรู้ของ Mautic นั้นมีประโยชน์มาก แต่ก็ต้องมีบทแนะนำและคู่มือแบบอัปเดตใหม่ รวมถึงการสร้างบทแนะนำใหม่ๆ และเพื่อให้สอดคล้องกับเวอร์ชัน Mautic 3x
ฉันประทับใจครั้งแรกเมื่ออ่านเอกสารที่มีอยู่ ปัจจุบัน Mautic Knowledgebase พร้อมให้บริการที่ https://kb.mautic.org/ บางหัวข้อบทแนะนำ วิธีการ ตลอดจนแนวทางปฏิบัติแนะนำในเอกสารประกอบไม่เป็นปัจจุบันและมีปริมาณน้อยหรือไม่สมบูรณ์ รวมถึงยังไม่ครอบคลุมข้อมูลเกี่ยวกับเวอร์ชันปัจจุบันของ
เหตุใดการปรับปรุงที่คุณเสนอดีกว่าพื้นที่/พื้นที่ปัจจุบันที่ฉันต้องการมีส่วนร่วม การปรับปรุงที่นำเสนอนี้จะช่วยปรับปรุงและรับรองประสิทธิภาพ ความสม่ำเสมอ และความสบายใจสำหรับผู้ใช้ปลายทาง โดยจะมีบทแนะนำที่เป็นลายลักษณ์อักษร คำแนะนำวิธีใช้ แนวทางปฏิบัติแนะนำ และรูปภาพที่เกี่ยวข้อง รวมถึงวิธีการและคำอธิบายเกี่ยวกับวิธีการใช้แต่ละฟีเจอร์ของฟีเจอร์ที่เป็นประโยชน์ เป็นปัจจุบัน ไปยังส่วนต่างๆ ได้ง่าย และเข้าใจได้ง่าย
การวิเคราะห์
Mautic Knowledgebase เขียนขึ้นใน 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)
- ส่งรายงานโครงการและการประเมินโดยที่ปรึกษาของฉัน
- เขียนและส่งรายงานประสบการณ์ของฉันในฐานะผู้เข้าร่วมในซีซันของเอกสาร