โปรเจ็กต์ VLC

หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs

สรุปโปรเจ็กต์

องค์กรโอเพนซอร์ส:

VLC

นักเขียนเชิงเทคนิค

Avii

ชื่อโปรเจ็กต์:

สร้างเอกสารผู้ใช้ VLC สำหรับพอร์ตอุปกรณ์เคลื่อนที่ (Android) 1 พอร์ต

ระยะเวลาของโปรเจ็กต์

ระยะเวลามาตรฐาน (3 เดือน)

คำอธิบายโปรเจ็กต์

ABSTRACT

เอกสารประกอบของผู้ใช้ใช้เป็นระบบการสนับสนุนแบบคงที่เพื่อช่วยเหลือผู้ใช้ปลายทาง โดยให้ข้อมูลทั้งทางเทคนิคและข้อมูลที่ไม่ใช่ทางเทคนิคเกี่ยวกับผลิตภัณฑ์หรือบริการ ช่วยให้ผู้ใช้เรียนรู้วิธีใช้ซอฟต์แวร์หรือบริการ ผู้ใช้บางรายอาจไม่ต้องการติดต่อทีมสนับสนุนหรือรอการตอบกลับทางอีเมลหากต้องการเพียงคำแนะนำ เคล็ดลับ หรือเทคนิคเล็กๆ น้อยๆ เอกสารประกอบสำหรับผู้ใช้ก็ทำหน้าที่ดังกล่าว ทั้งยังลดต้นทุนในการสนับสนุนและเป็นเอกลักษณ์ของประสิทธิภาพผลิตภัณฑ์และทีมนักพัฒนา

VLC สำหรับ Android ได้รับการดาวน์โหลดมากกว่า 100 ล้านครั้งจาก Google Play Store เพียงแห่งเดียว VLC มีฟีเจอร์มากมายสำหรับพอร์ตเวอร์ชันอุปกรณ์เคลื่อนที่ ตั้งแต่การเล่นเสียงและวิดีโอไปจนถึงสตรีมเครือข่าย บ่อยครั้งที่ผู้คนต้องการใช้ฟีเจอร์ที่ยอดเยี่ยมเหล่านี้ แต่ไม่สามารถดำเนินการได้ การค้นหาบล็อกหรือวิดีโอแบบสุ่มเพื่อดูข้อมูลนี้ต้องใช้เวลาและความอดทนเป็นอย่างมาก และข้อมูลที่ได้ก็ยังไม่แน่ชัด ปัจจุบัน VLC โฮสต์เอกสารประกอบสำหรับผู้ใช้ VLC สำหรับ Android ในหน้า Wiki และให้คำอธิบายฟีเจอร์เหล่านี้น้อยมากหรือไม่มีเลย นอกจากนี้ หน้าวิกิได้รับการอัปเดตครั้งล่าสุดในเดือนมีนาคม 2019 โปรเจ็กต์ปัจจุบันจะมีเอกสารประกอบสำหรับผู้ใช้ใหม่ที่มีการออกแบบที่ทันสมัยและใช้งานได้ง่ายขึ้นสำหรับพอร์ต Android

สถานการณ์ปัจจุบัน

หน้าวิกิพีเดียล้าสมัยแล้วและมีข้อมูลเกี่ยวกับ VLC เวอร์ชันล่าสุดน้อยมาก และใช้งานยาก โดยจะไม่เห็นตัวเลือกให้อ่านเอกสารประกอบในภาษาอื่นนอกเหนือจากภาษาอังกฤษ โดยไม่มีคำอธิบายฟีเจอร์เลย

การวิเคราะห์

-> ขณะนี้เอกสารประกอบปัจจุบันล้าสมัยแล้วและต้องเขียนใหม่โดยใช้แพลตฟอร์มและเครื่องมืออื่น

-> ผู้ใช้ Android ส่วนใหญ่มีความรู้ทางเทคนิคน้อยหรือไม่มีความรู้ทางเทคนิคเลย แต่ก็มีผู้ใช้ที่ต้องการข้อมูลทางเทคนิคเพิ่มเติมเกี่ยวกับฟีเจอร์ การเขียนและดูแลรักษาเอกสารประกอบแยกกัน 2 รายการสำหรับวัตถุประสงค์แต่ละอย่างข้างต้นนั้นไม่เหมาะ หรือแม้กระทั่งในเอกสารประกอบเรื่องเดียวกัน การแบ่งฟีเจอร์ออกเป็นด้านเทคนิคและที่ไม่ใช่ทางเทคนิคก็ทำให้เกิดความสับสนมากขึ้นได้เช่นกัน เนื่องจากผู้ใช้ส่วนใหญ่คุ้นเคยกับ UI ที่เห็นหรือฟีเจอร์ที่ใช้อยู่ ทุกคนจึงตัดสินใจได้ยากว่าบางอย่างเป็นเทคนิคหรือไม่เป็นเทคนิค เราจึงอยากทำให้กระบวนการนี้ง่ายขึ้นสำหรับพวกเขา

-> ผู้ใช้ส่วนใหญ่จะพยายามรับข้อมูลผ่านสมาร์ทโฟนของตนเองและรับข้อมูลที่เหลือผ่านเดสก์ท็อปหรืออุปกรณ์อื่นๆ เอกสารประกอบจึงควรนำไปปรับใช้กับหน้าจอทุกขนาดได้โดยง่าย และต้องไม่เกิดความสับสนเกี่ยวกับการนำทาง

-> ฟีเจอร์บางอย่างของเวอร์ชันเดสก์ท็อปอาจไม่พร้อมใช้งานในพอร์ต Android และหากพร้อมใช้งาน ฟีเจอร์ดังกล่าวอาจทำงานไม่เหมือนกันทั้ง 2 พอร์ต เนื่องจากแอปพลิเคชันบนเดสก์ท็อปได้รับการพัฒนามาเป็นเวลานานกว่ามากและอยู่ในสถานะที่ค่อนข้างอิ่มตัวแล้ว ในทางตรงกันข้าม พอร์ตสำหรับอุปกรณ์เคลื่อนที่ยังค่อนข้างใหม่และยังอยู่ระหว่างการพัฒนา นอกจากนี้ แม้ว่าปัจจุบันอุปกรณ์เคลื่อนที่จะมีประสิทธิภาพมากขึ้น แต่ก็มีข้อจำกัดที่ชัดเจนเกี่ยวกับประเภทฟีเจอร์ที่เรานำมารวมใช้ได้ ส่วนใหญ่เป็นเพราะดีมานด์ของผู้ใช้ การมีฟีเจอร์ที่ไม่มีใครใช้เป็นการสิ้นเปลืองทรัพยากรการพัฒนา ดังนั้นจึงไม่แนะนําให้แปลงเอกสารประกอบทั้ง 2 รายการตามฟีเจอร์

จากการวิเคราะห์ข้างต้น ฉันนำเสนอข้อมูลต่อไปนี้ 1. ขณะนี้เอกสารประกอบสำหรับผู้ใช้เดสก์ท็อปใช้เครื่องมือสร้างเอกสารประกอบ Sphinx และธีม Read the Docs การใช้ชื่อเดียวกันกับพอร์ต Android จะช่วยเราในลักษณะต่อไปนี้ -> ผสานเอกสารประกอบทั้ง 2 รายการได้อย่างง่ายดาย -> เพิ่มประสิทธิภาพให้เหมาะกับหน้าจอทุกขนาด -> ประสบการณ์ที่ราบรื่นขณะไปยังเอกสารประกอบสำหรับผู้ใช้ Android ผ่านเอกสารบนเดสก์ท็อป

1. การแยกบท ส่วน และส่วนย่อยตามตำแหน่งสัมพัทธ์ในแอปพลิเคชัน ตัวอย่างเช่น โหมดพื้นหลัง/PIP อยู่ใน "เพิ่มเติม" -> "การตั้งค่า" -> "วิดีโอ" ดังนั้นโครงสร้างของบทจะ

   เพิ่มเติม

   |__Settings

   | |__คลังสื่อ

   | |__วิดีโอ --> โหมดพื้นหลัง/PIP

   : -> แนวทางนี้จะเพิ่มความสะดวกในการเข้าถึง เนื่องจากผู้ใช้จะไปยังส่วนที่ต้องการความช่วยเหลือได้โดยง่ายด้วยการเปรียบเทียบกับตําแหน่งที่เกี่ยวข้องในแอปพลิเคชัน สำหรับฟีเจอร์แต่ละรายการ เราสามารถแยกส่วนที่เป็นเทคนิคและไม่ใช่เทคนิคออกจากกันได้ เราจะเขียนคำอธิบายที่เข้าใจง่ายแบบไม่ใช่เชิงเทคนิคก่อน จากนั้นไฮไลต์หรือติดป้ายกำกับส่วนทางเทคนิคของฟีเจอร์เดียวกัน (หากมี) ไว้ด้านล่าง ซึ่งอาจทำให้เนื้อหาซ้ำกันบ้าง แต่จะช่วยให้ผู้ใช้ส่วนใหญ่ที่ไม่ใช่ผู้เชี่ยวชาญด้านเทคนิคได้รับประสบการณ์การใช้งานที่ราบรื่น ซึ่งจะช่วยในอนาคตด้วยโดยเพิ่มความสามารถในการบำรุงรักษา เนื่องจากแอปพลิเคชันจะถึงจุดอิ่มตัว UI ที่เกี่ยวข้องจึงมีแนวโน้มที่จะเปลี่ยนแปลงไม่มากนัก ดังนั้นในอนาคตหากมีการเพิ่ม/นําฟีเจอร์ใหม่ออก เราก็จะรีแฟกทอเรียลส่วนนั้นได้โดยง่าย ในกรณีที่มีการเปลี่ยนแปลง UI ทั้งหมด เราสามารถจัดเรียงส่วน/บทใหม่ หรือปรับโครงสร้างเอกสารทั้งหมด ไม่ว่าในกรณีใด เราจำเป็นต้องแก้ไขเอกสารทั้งหมด เนื่องจากจะต้องแทนที่ภาพหน้าจอเพื่อให้ตรงกับ UI ปัจจุบัน เรามีเดโมที่ใช้งานได้โฮสต์ไว้ที่นี่ https://avinal.gitlab.io/vlc-android-docs/

2. แต่ละส่วนของเอกสารประกอบควรประกอบด้วยภาพหน้าจอที่ติดป้ายกำกับ คำอธิบายฟีเจอร์ ส่วนที่เป็นเทคนิคเพิ่มเติม (หากมี) และเคล็ดลับเกี่ยวกับฟีเจอร์

-> การพัฒนาเอกสารประกอบสำหรับผู้ใช้นี้จากเดสก์ท็อปด้วยตนเองจะช่วยให้เราผสานเอกสารประกอบทั้ง 2 รายการได้ในไม่กี่ขั้นตอนโดยไม่ส่งผลกระทบต่อเอกสารประกอบปัจจุบันหรือได้รับผลกระทบจากเอกสารประกอบดังกล่าวในระหว่างการพัฒนา เราขอแนะนำให้วางเอกสารประกอบทั้งหมดนี้ในส่วน Android ของเอกสารประกอบสำหรับเดสก์ท็อปเมื่อพัฒนาเสร็จแล้ว จากนั้นสร้างลิงก์ถาวรสำหรับเอกสารประกอบ VLC สำหรับ Android

-> การปรับปรุงเพิ่มเติมอาจรวมถึงการออกแบบหน้าเริ่มต้นของเอกสารประกอบสำหรับผู้ใช้เดสก์ท็อปใหม่เพื่อให้ผู้ใช้เลือกระบบปฏิบัติการที่ต้องการได้โดยตรง จากนั้นจึงเปลี่ยนเส้นทางไปยังเอกสารประกอบของระบบปฏิบัติการที่เลือก เนื่องจากเอกสารประกอบสำหรับผู้ใช้ VLC บน Windows, MacOS และ Linux ได้รับการออกแบบและเขียนขึ้นอย่างดีแล้ว เราจึงอาจใส่ตัวเลือกให้ผู้ใช้เลือกระหว่าง Windows/MacOS/Linux หรือ Android หรือ iOS ซึ่งจะทำให้เอกสารประกอบของผู้ใช้แยกกันอย่างชัดเจนแต่รวมเป็นหนึ่งเดียวโดยมีเพียงลิงก์เดียวสำหรับพอร์ตทั้งหมด

เหตุใดเอกสารประกอบของผู้ใช้ที่ฉันเสนอจึงดีกว่า เอกสารสำหรับผู้ใช้ที่เสนอนี้มีโครงสร้างโดยอิงตามรูปแบบทั่วไป ตามด้วยผู้ใช้ปลายทางเพื่อขอความช่วยเหลือ เอกสารประกอบจะรวมฟีเจอร์ที่จำเป็นทั้งหมด เช่น ความเรียบง่าย ความชัดเจน รูปลักษณ์ ความรู้ด้านเทคโนโลยี เพื่อเพิ่มความสะดวกในการใช้งานและประสบการณ์ของผู้ใช้ปลายทางให้มากที่สุด นอกจากนี้ การดูแลรักษายังทำได้ง่ายขึ้นเนื่องจากไม่จำเป็นต้องเก็บเอกสารของผู้ใช้แต่ละรายสำหรับพอร์ตทุกรายการอีกต่อไป

เหตุใดฉันจึงเหมาะกับโปรเจ็กต์นี้ -> ฉันเขียนโค้ดมา 2 ปีแล้ว และบ่อยครั้งที่ต้องอ่านเอกสารประกอบของ API สําหรับไลบรารีหรือซอฟต์แวร์บางรายการ หรือแม้แต่เขียนเอกสารประกอบโค้ดของตัวเอง เพื่อให้ฉันรู้แน่ชัดว่าผู้คนต้องการดูอะไรในเอกสาร ปัญหาที่พวกเขาเผชิญอยู่ และวิธีขอความช่วยเหลือ ฉันจะใช้ประสบการณ์เดียวกันนี้ในการเขียนเอกสารประกอบที่สอดคล้องกันและอ่านง่าย

-> ฉันเขียนเนื้อหาทางเทคนิคใน Quora, Stack Overflow และแพลตฟอร์มอื่นๆ อยู่เสมอ ฉันรู้วิธีอธิบายสิ่งต่างๆ ในลักษณะที่น่าสนใจและผู้คนเข้าใจได้ง่าย

-> VLC สำหรับ Android เป็นเครื่องมือที่มีประสิทธิภาพและมีชื่อเสียงมาก แต่ฟีเจอร์ส่วนใหญ่ของ VLC นั้นไม่เป็นที่รู้จักหรือไม่มีความช่วยเหลือ ฉันใช้งาน VLC ทั้งบนแพลตฟอร์มเดสก์ท็อปและอุปกรณ์เคลื่อนที่มาหลายปีแล้ว และฉันก็รู้ดีว่าผู้ใช้อาจพบปัญหาใด เราใช้ความรู้และประสบการณ์ทั้งหมดที่มีเพื่อให้เอกสารประกอบที่ยอดเยี่ยม