หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- โคลิบรี
- ผู้เขียนด้านเทคนิค:
- แดเนียล วี
- ชื่อโปรเจ็กต์:
- เวิร์กโฟลว์ของเนื้อหา Kolibri
- ระยะเวลาของโปรเจ็กต์:
- วิ่งเป็นเวลานาน (5 เดือน)
คำอธิบายโปรเจ็กต์
ข้อเสนอด้านล่างจัดทำขึ้นโดยการวิจัยและพูดคุยกับที่ปรึกษาของ Kolibri การสนทนากับ Mentor ช่วยให้ฉันพัฒนาลักษณะตัวตนของผู้ใช้ตามที่พูดถึงด้านล่าง นอกจากนี้ การสนทนาของผมยังช่วยให้ผมเกิดไอเดียเกี่ยวกับที่เก็บบทแนะนำ/หน้า Landing Page เพื่อให้ผู้ใช้เลือกได้ว่าต้องการดูบทแนะนำใดตามความต้องการ
ภาพรวม
ข้อเสนอนี้นำเสนอโซลูชันเพื่อแนะนำเส้นทางต่างๆ ของผู้ใช้ ซึ่งบุคคลธรรมดาสามารถนำการนำเข้าเนื้อหาจากคอมพิวเตอร์ไปยัง Kolibri Studio แล้วจาก Kolibri Studio ไปยัง Kolibri ฉันขอเสนอที่จะสร้างที่เก็บบทแนะนำแบบรวมศูนย์ ผู้ใช้จะเข้าถึงบทแนะนำเหล่านี้ได้ผ่านหน้า Landing Page หน้า Landing Page จะมีตารางที่มีลิงก์ไปยังบทแนะนำเวิร์กโฟลว์แต่ละบท และจะระบุประเภทของผู้ใช้ที่อาจเป็นประโยชน์ในบทแนะนำ วิธีนี้จะทำให้บทแนะนำปรับเปลี่ยนให้เหมาะกับความต้องการและความสามารถของผู้ใช้มากขึ้น แสดงเวิร์กโฟลว์ (เช่น INSTALL- IMPORT) จากหลายบทเรียน แต่ละบทเรียนจะมีวิดีโอ วิดีโอจะแสดงส่วนเล็กๆ ของเวิร์กโฟลว์และสาธิตแนวคิดส่วนบุคคลเกี่ยวกับวิธีที่เวิร์กโฟลว์เหล่านี้เชื่อมต่อกับแอปพลิเคชันของ Kolibri
เป้าหมายหลัก
สร้างหน้า Landing Page สำหรับบทแนะนำที่ช่วยผู้ใช้ตัดสินใจว่าเวิร์กโฟลว์ใดเหมาะกับความต้องการของตนที่สุด หน้า Landing Page นี้จะโฮสต์บนแพลตฟอร์มอ่านเอกสาร
สร้างบทเรียนเดี่ยวๆ สำหรับองค์ประกอบของแต่ละเวิร์กโฟลว์ และเสริมบทเรียนยากๆ ด้วยแบบฝึกหัด
สร้างวิดีโออินเทอร์แอกทีฟสำหรับแต่ละเวิร์กโฟลว์
เครื่องมือของโครงการ
การทำงานจะเสร็จสิ้นโดยใช้ซอฟต์แวร์การเผยแพร่หน้าจอ ฉันมีประสบการณ์กับ Camtasia แต่ก็เคยใช้ซอฟต์แวร์และฟรีแวร์ที่เสียค่าใช้จ่ายน้อยกว่าด้วย วิดีโอตัวอย่างที่ลิงก์ที่นี่ (https://youtu.be/DkMP_VdGslU) สร้างขึ้นโดยใช้ Flashback โดย Blueberry Software ซึ่งปัจจุบันฉันมีใบอนุญาต ฉันจะสร้างคำบรรยายโดยใช้ YouTube หน้าบทแนะนำจะโฮสต์ในเว็บไซต์อ่านเอกสารของ Kolibri งานฉบับร่างจะเสร็จใน Google เอกสาร และเราสามารถช่วยแปลงไฟล์ข้อความเป็น Markdown หรือ reStructuredText สำหรับผลิตภัณฑ์สุดท้ายได้
ลำดับเวลา
โครงการนี้จะเป็นไปตามแนวทางโครงการระยะยาว (รวม 26 สัปดาห์ ตั้งแต่ 2/9/2019-28/2/2020) โดยจะใช้เวลาสัปดาห์ละประมาณ 10 ชั่วโมงในการทำตามเป้าหมายที่ระบุไว้ด้านล่าง นอกเหนือจากเป้าหมายเหล่านี้ ฉันจะเข้าร่วมการประชุมและการสื่อสารกับที่ปรึกษาในระหว่างเวลานี้ตามที่จำเป็น ฉันจะทำงานร่วมกับที่ปรึกษาเพื่อกำหนดเวลาที่เหมาะสมที่สุดสำหรับเรื่องนี้ โดยทั่วไปแล้ว ไทม์ไลน์จะแบ่งออกเป็นส่วนๆ 4 สัปดาห์ โดยผมจะสร้างวิดีโอ หน้าบทแนะนำ และแบบฝึกหัดหลายรายการ
สัปดาห์ที่ 1 และ 2
เป้าหมาย
- ตั้งค่าอุปกรณ์ส่วนตัวให้เว็บไซต์หรือบัญชีที่จำเป็นในการเข้าถึงข้อมูล
- เริ่มพัฒนาโครงสร้างและโครงลวดที่ละเอียดมากขึ้นสำหรับหน้า Landing Page
- พูดคุยกับที่ปรึกษาเกี่ยวกับสไตล์ของวิดีโอ รวมถึงพัฒนาเทมเพลตหน้าจอเปิดวิดีโอ เพลงประกอบสำหรับเพลงประกอบวิดีโอและตอนท้าย และข้อมูลเพิ่มเติมที่ควรระบุ
- โปรดอ่านโครงสร้างเอกสารประกอบและเอกสารปัจจุบันเพื่อดึงลิงก์เพื่อใช้ในแหล่งข้อมูลเพิ่มเติมและข้อมูลอ้างอิงจากบทแนะนำ
สัปดาห์ที่ 3 ถึง 6 (ระดับ 1 - บทแนะนำมือใหม่)
เป้าหมาย
- สร้างเนื้อหาและบทเรียนเบื้องต้นสำหรับเวิร์กโฟลว์ INSTALL-IMPORT/ระดับ 1 สร้างวิดีโอสำหรับขั้นตอนการดาวน์โหลด ติดตั้ง กำหนดค่า และนำเข้า เนื่องจากฟังก์ชัน INSTALL-IMPORT เป็นพื้นฐานสําหรับเวิร์กโฟลว์อื่นๆ จำนวนมากและมีการใช้มากที่สุด เวลาส่วนใหญ่จึงเป็นการสรุปบทแนะนำและบทเรียนเหล่านี้
- มุ่งเน้นที่ประเภทสถานที่ใน IMPORT และพัฒนากราฟิกที่แสดงตัวอย่างให้ผู้ใช้ได้มาซึ่งเนื้อหา (ช่องทางสาธารณะที่อยู่ใน Kolibri Studio) สําหรับหน้า Landing Page
- พัฒนาวิดีโอและเนื้อหาเพิ่มเติมสำหรับการขยายการใช้งานของ INSTALL-IMPORT (อัปเดตช่อง) การขยายนี้อาจมาในรูปแบบของแหล่งข้อมูลเพิ่มเติมหรือลิงก์ไปยังเอกสารประกอบที่มีอยู่
- สร้างคำบรรยายสำหรับวิดีโอใดก็ได้
- "ทดสอบ" และขอความคิดเห็นจากแหล่งข้อมูลที่มีเกี่ยวกับความสามารถในการใช้งาน ซึ่งรวมถึงการกลับไปที่เทมเพลตสำหรับวิดีโอและสร้างเทมเพลตสำหรับการสร้างวิดีโอในอนาคต
สัปดาห์ที่ 7 ถึง 10 (ระดับ 2 - ผู้อัปโหลดเนื้อหา)
เป้าหมาย
- เน้นวิดีโอบทเรียนและวิดีโอเกี่ยวกับเวิร์กโฟลว์สำหรับลักษณะตัวตนของ Studio Uploader
- เอกสารประกอบและบทเรียนสำหรับ UPLOAD-PUBLISH-IMPORT ที่สมบูรณ์
- สร้างคำบรรยายสำหรับวิดีโอ
สัปดาห์ 11 ถึง 14 (ระดับ 3 - เนื้อหา "รีมิกซ์" และบรรณาธิการ)
เป้าหมาย
- มุ่งเน้นที่เวิร์กโฟลว์ต่อไปนี้ แล้วสร้างเนื้อหาบทแนะนำ/บทเรียน: UPLOAD-EDIT-PUBLISH-UPDATE และ EDIT-PUBLISH-UPDATE
- สร้างคำบรรยายสำหรับวิดีโอ
สัปดาห์ที่ 15-18
เป้าหมาย
- ตามที่ได้แจ้งไว้ในระหว่างการค้นคว้าข้อเสนอนี้ เวิร์กโฟลว์ที่เกี่ยวข้องกับ Ricecooker จะมีความสำคัญต่ำกว่า (ประเภท CHEFDEV) ผมควรใช้เวลานี้สร้างบทแนะนำภาพรวมเกี่ยวกับเอกสารประกอบที่มีอยู่แล้วสำหรับ Ricecooker ทั้งนี้ขึ้นอยู่กับช่วงเวลาและตารางเวลา
สัปดาห์ที่ 19 ถึง 22
เป้าหมาย
- ประเมินช่องว่างที่มีในตอนนี้ และทดสอบโฟลว์ปัจจุบันของบทแนะนำทั้งหมด
- ปรับแต่งหน้า Landing Page ให้เรียบร้อยและเริ่มลิงก์วิดีโอเข้าด้วยกัน
- ลองแปลงฉบับร่างของหน้าเว็บที่ทำใน Google เอกสารเป็นมาร์กดาวน์หรือปรับโครงสร้างข้อความตามที่ปรึกษากับที่ปรึกษา
สัปดาห์ที่ 23-25
เป้าหมาย
- เขียนบทแนะนำขั้นสูงที่มีลำดับความสำคัญต่ำให้เสร็จ ทั้งนี้ขึ้นอยู่กับเวลา
- นาทีสุดท้าย อ่านการแก้ไขหน้าเอกสาร การทดสอบไฟล์ การตรวจสอบไวยากรณ์/การสะกดคำ
- QA สำหรับลิงก์ในวิดีโอหรือหน้าอื่นๆ
สัปดาห์ที่ 26
สัปดาห์สุดท้ายสำหรับโครงการระยะยาว ฉันจะทำงานร่วมกับที่ปรึกษาเพื่อสรุปสิ่งที่ส่งมอบของโครงการและจัดทำเอกสารฉบับสุดท้ายที่จำเป็นของ Google ให้เสร็จสิ้น
องค์ประกอบของบทแนะนำ
หน้า Landing Page ของบทแนะนำ
ผู้ใช้จะสามารถเข้าถึงหน้า Landing Page ของบทแนะนำในเว็บไซต์อ่านเอกสารของ Kolibri ซึ่งจะแสดงข้อมูลสรุปคร่าวๆ ของบทแนะนำต่างๆ ที่มีไว้สำหรับเวิร์กโฟลว์ของเนื้อหา หน้านี้มีจุดประสงค์เพื่อให้ภาพรวมคร่าวๆ เกี่ยวกับระบบนิเวศของ Kolibri รวมถึงการแสดงภาพรวมเกี่ยวกับเวิร์กโฟลว์ต่างๆ วิธีนี้จะช่วยให้ผู้ใช้ดูประเภทของเวิร์กโฟลว์ที่เหมาะกับความต้องการได้ ทั้งในแง่เทคนิคและหลักสูตรขององค์กร ผู้ใช้จะเข้าใจตัวเลือกที่มีใน Kolibri และ Kolibri Studio มากขึ้น
หน้าบทแนะนำและบทเรียน
หน้าแรกของบทแนะนำแต่ละหน้าจะแสดงบทแนะนำ (ประกอบด้วยหลายบทเรียน) ตามด้วยเป้าหมายของผู้ใช้บางส่วน บทแนะนำจะแสดงให้เห็นขั้นตอนการทำงานทั้งหมดและประกอบด้วยบทเรียนเดี่ยว แต่ละบทเรียนจะมีวิดีโอ วิดีโอจะครอบคลุมแต่ละส่วนของแนวคิดโดยรวม ระบบจะเก็บบทเรียนแต่ละบทไว้ในหน้าแต่ละหน้าภายในหน้าหลักสำหรับเวิร์กโฟลว์ของบทแนะนำ หน้าบทเรียนจะมีปุ่มที่ให้ผู้ใช้ข้ามไปยังบทเรียนก่อนหน้าหรือถัดไปในบทแนะนำได้ แนวคิดที่ซับซ้อนมากอาจมีกิจกรรมฝึกหัดรวมอยู่ด้วย
วิดีโอและโครงสร้าง
วิดีโอจะสรุปแนวคิดเดียว วิดีโอจะชี้ทางขณะที่ทำการดำเนินการนั้นบนหน้าจอ ดูวิดีโอตัวอย่างได้ที่ https://youtu.be/DkMP_VdGslU วิดีโอตัวอย่างนี้แสดงวิธีใช้วิซาร์ดสิ่งอำนวยความสะดวกในการตั้งค่า
วิดีโอใช้ไฮไลต์และเคอร์เซอร์ที่ไฮไลต์เพื่อช่วยแนะนำผู้ใช้ตลอดขั้นตอนของแนวคิดหนึ่งๆ นี้ วิดีโอจะโฮสต์ไว้บน YouTube หากโฮสต์ใน YouTube ระบบจะสร้างคำบรรยายแทนเสียงโดยอัตโนมัติ จากนั้น ฉันจะแก้ไขคำบรรยายสำหรับการสะกด ไวยากรณ์ และเครื่องหมายวรรคตอน คำบรรยายเหล่านั้นสามารถส่งออกเป็นคำแปลใน Amara หรือเครื่องมือแปลอื่นได้ด้วย
วิดีโอจะมีหน้าจอชื่อที่สอดคล้องกัน ซึ่งฉันวางแผนที่จะปรึกษากับที่ปรึกษาในช่วง 2-3 สัปดาห์แรก นอกจากนี้ฉันจะใช้รูปแบบข้อความเสริมที่สอดคล้องกัน (ลูกศร ไฮไลต์เคอร์เซอร์ กล่อง) ซึ่งจะตัดสินใจร่วมกับที่ปรึกษาภายใน 2-3 สัปดาห์แรก
โครงสร้างตัวอย่าง
เวิร์กโฟลว์ที่ง่ายที่สุดคือ INSTALL-IMPORT ที่เป็นบทแนะนำทั้งหมด ในบทแนะนำนี้ มีบทเรียนที่เป็นไปได้ 2 บทพร้อมกับวิดีโอ:
- การดาวน์โหลด ติดตั้ง และตั้งค่าสิ่งอำนวยความสะดวกของ Kolibri
- การนำเข้าเนื้อหาใน Kolibri Studio - โปรดทราบว่าเวิร์กโฟลว์อื่นๆ จะอ้างอิงถึงวิดีโอนี้
บทแนะนำขั้นสูงขึ้นต้องใช้บทเรียนย่อยหลายบทเรียนที่มีวิดีโอหลายรายการ เวิร์กโฟลว์ UPLOAD-EDIT-PUBLISH-UPDATE จะใช้โครงสร้างด้านล่าง
บทที่ 1 – การอัปโหลดเนื้อหาและการสร้างช่องใน Kolibri Studio
เป้าหมายของผู้ใช้: เมื่อจบบทเรียนนี้ คุณจะทราบวิธีดำเนินการต่อไปนี้
- สร้างช่องใน Kolibri Studio เพื่อใช้ใน Kolibri คุณจะได้ทราบวิธีใช้โทเค็นลับของช่องเพื่อนำเข้าช่องเนื้อหาใน Kolibri
- สร้างช่องโดยการนำเข้าเนื้อหาจากช่องสาธารณะที่มีอยู่ในไลบรารีของ Studio
- สร้างช่องโดยการอัปโหลดเนื้อหาจากคอมพิวเตอร์
วิดีโอบทเรียนย่อย:
- บทเรียนย่อย 1 – สร้างช่องของคุณเองใน Kolibri Studio และนำเข้าเนื้อหาจากช่องสาธารณะที่มีอยู่ (Khan Academy, PHET ฯลฯ) วิดีโอ 1 - ช่องเนื้อหาสาธารณะ (การดูช่องสาธารณะใน Kolibri Studio) วิดีโอ 2 – การสร้างช่อง วิดีโอ 3 – การนำเข้าเนื้อหาจากช่องที่มีอยู่ วิดีโอ 4 – การเผยแพร่ช่องของคุณและรับโทเค็นลับ วิดีโอ 5 – การนำเข้าช่องของคุณไปยัง Kolibri โดยใช้โทเค็นลับ
- บทเรียนย่อย 2—การอัปโหลดช่องเนื้อหาเอกสารของฉัน: วิดีโอ 1 – การอัปโหลดไฟล์จากเอกสารของฉัน วิดีโอ 2—การสร้างแบบฝึกหัดของคุณเอง
บทที่ 2 – การแก้ไขช่องขั้นสูงใน Kolibri Studio
เป้าหมายของผู้ใช้: เมื่อจบบทเรียนนี้ คุณจะทราบวิธีดำเนินการต่อไปนี้
- แก้ไขช่องเนื้อหาใน Kolibri Studio
- จัดการช่องเนื้อหาใน Kolibri Studio
วิดีโอบทเรียนย่อย:
- บทเรียนย่อย 1 - แก้ไขเนื้อหาโดยการเพิ่มแบบฝึกหัด การจัดระเบียบโครงสร้างโฟลเดอร์ใหม่ และตัวเลือกการทำงานร่วมกัน (วิดีโอ 1 รายการ)
- บทเรียนย่อย 2—การใช้ฟังก์ชันอื่นๆ เช่น การลบ/ย้ายเนื้อหา (วิดีโอ 1 รายการ)
บทที่ 3 – การเผยแพร่ช่องของ Kolibri Studio เพื่อใช้ใน Kolibri และการอัปเดตช่อง
เป้าหมายของผู้ใช้: เมื่อจบบทเรียนนี้ คุณจะทราบวิธีดำเนินการต่อไปนี้
- เผยแพร่ช่องใน Kolibri Studio และเผยแพร่อีกครั้งหลังจากเพิ่มเนื้อหาใหม่
- อัปเดตช่อง
- รับโทเค็นของช่องเพื่อนำเข้าไปยัง Kolibri (ผ่านลิงก์ไปยังวิดีโอก่อนหน้าในบทที่ 1 ที่ครอบคลุมการดำเนินการนี้)
วิดีโอบทเรียนย่อย:
บทเรียนย่อย 1 - การเผยแพร่อัปเดตไปยังช่อง
วิดีโอ 1: การเผยแพร่ช่องอีกครั้ง วิดีโอ 2: การอัปเดตช่องบน Kolibri หลังเพิ่มเนื้อหาเพิ่มเติม