Trang này được dịch bởi Cloud Translation API.

Dự án VLC

Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.

Tóm tắt dự án

Tổ chức nguồn mở:: VLC
Tác giả kỹ thuật:: Avii
Tên dự án:: Tạo Tài liệu người dùng VLC cho một cổng di động (Android)
Thời lượng dự án:: Thời hạn tiêu chuẩn (3 tháng)

Mô tả dự án

ABSTRACT

Tài liệu người dùng được dùng làm hệ thống hỗ trợ tĩnh để hỗ trợ người dùng cuối. Trang này cung cấp cả thông tin kỹ thuật và phi kỹ thuật về một sản phẩm hoặc dịch vụ. Giúp người dùng tìm hiểu cách sử dụng phần mềm hoặc dịch vụ. Không phải ai cũng muốn liên hệ với nhóm hỗ trợ hoặc chờ email trả lời nếu họ chỉ cần một chút hướng dẫn, mẹo hoặc thủ thuật. Tài liệu người dùng chỉ làm được điều đó. Việc này cũng giúp giảm chi phí hỗ trợ và là bản sắc của tình trạng sản phẩm cũng như nhóm nhà phát triển.

Chỉ riêng Cửa hàng Google Play đã có hơn 100 triệu lượt tải VLC cho Android xuống. VLC cung cấp nhiều tính năng cho các cổng dành cho thiết bị di động, từ phát âm thanh-video đến truyền trực tuyến qua mạng. Thông thường, mọi người muốn sử dụng những tính năng tuyệt vời này nhưng không thể làm được. Việc tìm kiếm một blog hoặc một số video ngẫu nhiên để làm việc này đòi hỏi nhiều thời gian và sự kiên nhẫn, nhưng vẫn không có thông tin xác thực nào được thu thập. Hiện tại, VLC lưu trữ tài liệu dành cho người dùng VLC cho Android trên trang wiki và cung cấp ít hoặc không có nội dung mô tả về các tính năng này. Ngoài ra, các trang wiki được cập nhật lần gần đây nhất vào tháng 3 năm 2019. Dự án hiện tại sẽ cung cấp Tài liệu người dùng mới với thiết kế hiện đại và dễ sử dụng hơn cho cổng Android.

TÌNH HÌNH HIỆN TẠI

Các trang wiki đã hoàn toàn lỗi thời và chứa rất ít thông tin về phiên bản VLC mới nhất. Ngoài ra, các tệp này không dễ sử dụng. Không có lựa chọn nào để đọc tài liệu bằng ngôn ngữ khác ngoài tiếng Anh. Trang này không chứa nội dung mô tả tính năng.

PHÂN TÍCH

-> Hiện tại, tài liệu hiện tại đã lỗi thời và cần được viết theo cách mới cũng như sử dụng một nền tảng và công cụ khác.

-> Hầu hết người dùng Android đều có ít hoặc không có kiến thức kỹ thuật. Tuy nhiên, vẫn có những người cần thêm thông tin kỹ thuật về một tính năng. Việc viết và duy trì hai tài liệu riêng biệt cho mỗi mục đích ở trên không phải là việc nên làm. Hoặc thậm chí trong cùng một tài liệu phân chia một tính năng dựa trên kỹ thuật và phi kỹ thuật sẽ tạo ra thêm sự nhầm lẫn. Xin nhắc lại rằng hầu hết người dùng đã quen với giao diện người dùng mà họ nhìn thấy hoặc các tính năng mà họ sử dụng, nên không phải ai cũng dễ dàng quyết định xem một nội dung nào đó có mang tính kỹ thuật hay không. Vì vậy, chúng ta muốn đơn giản hoá việc này cho họ.

-> Hầu hết người dùng sẽ cố gắng tìm thông tin thông qua điện thoại thông minh và phần còn lại thông qua máy tính hoặc các thiết bị khác. Vì vậy, tài liệu phải dễ dàng thích ứng với mọi kích thước màn hình. Và không gây nhầm lẫn về việc điều hướng.

-> Không phải tính năng nào của phiên bản máy tính cũng có trong cổng Android và nếu có thì cũng không hoạt động giống nhau trong cả hai cổng. Điều này là do ứng dụng dành cho máy tính đã được phát triển lâu hơn nhiều và đã đạt đến trạng thái bão hoà, trái ngược với cổng dành cho thiết bị di động còn tương đối mới và vẫn đang phát triển. Ngoài ra, mặc dù ngày nay các thiết bị di động đang trở nên mạnh mẽ hơn bao giờ hết, nhưng vẫn có những hạn chế rõ ràng về loại tính năng mà chúng ta có thể tích hợp, chủ yếu là do nhu cầu của người dùng cuối. Việc có một tính năng mà không ai sử dụng là lãng phí tài nguyên phát triển. Vì vậy, bạn không nên thảo luận cả hai tài liệu dựa trên các tính năng.

DỰA TRÊN PHÂN TÍCH TRÊN, TÔI ĐỀ XUẤT NHỮNG ĐIỀU SAU. 1. Hiện tại, tài liệu dành cho người dùng máy tính đang sử dụng trình tạo Tài liệu Sphinx và giao diện Read the Docs. Việc sử dụng cùng một tên cho cổng Android sẽ giúp chúng ta theo những cách sau: -> Dễ dàng hợp nhất cả hai tài liệu. -> Được tối ưu hoá cho mọi kích thước màn hình. -> Trải nghiệm liền mạch khi chuyển đến Tài liệu dành cho người dùng Android thông qua Tài liệu dành cho máy tính

Phân tách các chương, mục và tiểu mục theo vị trí tương đối trong ứng dụng. Ví dụ: Chế độ nền/PiP nằm trong phần Tuỳ chọn khác -> Cài đặt -> Video, vì vậy, cấu trúc phân cảnh sẽ là

Thêm

|__Cài đặt

| |__Thư viện nội dung nghe nhìn

| |__Video -->Chế độ nền/PiP

: -> Phương pháp này sẽ giúp cải thiện khả năng truy cập vì người dùng có thể dễ dàng điều hướng đến phần mà họ cần trợ giúp bằng cách so sánh phần đó với vị trí tương đối trong ứng dụng. Đối với mỗi tính năng, chúng ta có thể tách riêng phần kỹ thuật và phần phi kỹ thuật. Trước tiên, chúng ta sẽ viết một nội dung mô tả dễ hiểu không mang tính kỹ thuật, sau đó làm nổi bật hoặc gắn nhãn các phần kỹ thuật của cùng một tính năng (nếu có) ngay bên dưới. Điều này có thể dẫn đến một số nội dung lặp lại nhưng sẽ đảm bảo trải nghiệm mượt mà cho phần lớn người dùng không chuyên về kỹ thuật. Điều này cũng sẽ giúp ích trong tương lai bằng cách tăng khả năng bảo trì. Khi ứng dụng đạt đến trạng thái bão hoà, giao diện người dùng tương đối sẽ không thay đổi nhiều. Vì vậy, trong tương lai, nếu thêm/xoá một tính năng mới, chúng ta chỉ cần tái cấu trúc phần này. Trong trường hợp toàn bộ giao diện người dùng thay đổi, chúng ta có thể sắp xếp lại các phần/chương hoặc tái cấu trúc toàn bộ tài liệu. Trong cả hai trường hợp, chúng ta cần sửa đổi toàn bộ tài liệu vì ảnh chụp màn hình sẽ phải được thay thế để khớp với giao diện người dùng hiện tại. Bản minh hoạ đang hoạt động được lưu trữ tại đây : https://avinal.gitlab.io/vlc-android-docs/
Mỗi phần của tài liệu phải bao gồm một ảnh chụp màn hình được gắn nhãn , nội dung mô tả tính năng, phần kỹ thuật chuyên sâu hơn (nếu có) và các mẹo và thủ thuật cho tính năng đó.

-> Việc phát triển tài liệu người dùng này một cách độc lập trên máy tính sẽ giúp chúng ta hợp nhất cả hai tài liệu chỉ trong vài bước mà không ảnh hưởng đến tài liệu hiện tại hoặc bị tài liệu hiện tại ảnh hưởng trong quá trình phát triển. Tôi đề xuất đặt toàn bộ tài liệu này trong phần Android của tài liệu trên máy tính để bàn sau khi tài liệu này được phát triển và sau đó tạo liên kết cố định cho VLC cho tài liệu Android.

-> Các điểm cải tiến khác có thể bao gồm việc thiết kế lại trang bắt đầu của tài liệu dành cho người dùng máy tính để cho phép người dùng trực tiếp chọn hệ điều hành mà họ yêu thích, sau đó chuyển hướng đến tài liệu của hệ điều hành đã chọn. Vì tài liệu người dùng VLC cho Windows, MacOS và Linux đã được thiết kế và trao đổi kỹ lưỡng, nên chúng tôi có thể đưa ra các lựa chọn để chọn Windows/MacOS/Linux hoặc Android hoặc iOS. Điều này sẽ giúp tài liệu người dùng được phân tách độc đáo nhưng hợp nhất chỉ với một đường liên kết để sử dụng cho tất cả các cổng.

TẠI SAO TÀI LIỆU ĐỀ XUẤT CHO NGƯỜI DÙNG CỦA TÔI TỐT HƠN? Tài liệu người dùng đề xuất này có cấu trúc dựa trên các mẫu phổ biến mà người dùng cuối tuân theo để yêu cầu trợ giúp. Tài liệu này kết hợp tất cả các tính năng bắt buộc, chẳng hạn như Tính đơn giản, Tính rõ ràng, Giao diện, kiến thức công nghệ để tối đa hoá khả năng dễ sử dụng và trải nghiệm người dùng cuối. Điều này cũng dễ bảo trì vì bạn không cần duy trì tài liệu người dùng riêng lẻ cho mỗi cổng nữa.

TẠI SAO TÔI LÀ NGƯỜI PHÙ HỢP VỚI DỰ ÁN NÀY? -> Tôi đã viết mã được 2 năm và thường xuyên cần xem tài liệu API cho một số thư viện hoặc một số phần mềm hoặc thậm chí là tài liệu về mã của riêng tôi. Vì vậy, tôi biết chính xác những gì mọi người muốn thấy trong tài liệu, vấn đề họ gặp phải và cách họ tiếp cận để được trợ giúp. Tôi có thể áp dụng cùng một kinh nghiệm để viết một tài liệu nhất quán và dễ đọc.

-> Tôi đã tích cực viết các nội dung kỹ thuật trên Quora, Stack Overflow và nhiều nền tảng khác. Tôi biết cách giải thích thông tin theo cách hấp dẫn và dễ hiểu.

-> VLC dành cho Android là một công cụ mạnh mẽ và rất nổi tiếng, tuy nhiên hầu hết các tính năng của công cụ này đều chưa được biết hoặc không có trợ giúp. Tôi đã sử dụng VLC trên cả nền tảng máy tính và thiết bị di động trong nhiều năm và tôi biết người dùng có thể gặp phải những vấn đề gì. Bằng cách kết hợp tất cả kiến thức và kinh nghiệm của mình, tôi có thể đảm bảo sẽ cung cấp tài liệu chất lượng cao.