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