โปรเจ็กต์ VLC

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

ข้อมูลสรุปของโปรเจ็กต์

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

VLC

ผู้เขียนด้านเทคนิค:

อาวี

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

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

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

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

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

ขีดฆ่า

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

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

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

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

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

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

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

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

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

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

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

   เพิ่มเติม

   |__การตั้งค่า

   | |__ไลบรารีสื่อ

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

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

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

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

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

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

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

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

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