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 kỹ thuật được chấp nhận cho Phần Google Tài liệu.

Tóm tắt dự án

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

Mô tả dự án

TÓM TẮT

Tài liệu người dùng được dùng như một hệ thống hỗ trợ tĩnh để hỗ trợ người dùng cuối. 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 người nào cũng muốn liên hệ với bộ phận hỗ trợ hoặc đợi nhận email trả lời nếu tất cả những gì họ cần là một vài hướng dẫn, mẹo hoặc thủ thuật. Tài liệu về người dùng có chức năng đó. Dữ liệu này cũng giúp giảm chi phí hỗ trợ, đồng thời là thông tin nhận dạng về tính ổn định của sản phẩm và của nhóm nhà phát triển.

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

TÌNH TRẠNG 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, chúng không dễ điều hướng. Không có tuỳ chọn để đọc tài liệu bằng ngôn ngữ khác ngoài tiếng Anh. Phần này không chứa nội dung mô tả tính năng.

PHÂN TÍCH

-> Cho đến nay, 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 có ít hoặc không có kiến thức kỹ thuật. Nhưng có những người cần thêm thông tin kỹ thuật về một tính năng. Bạn không nên viết và duy trì hai tài liệu riêng biệt cho từng mục đích trên. 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 yếu tố kỹ thuật và phi kỹ thuật sẽ khiến người dùng nhầm lẫn hơn. Vì một lần nữa, hầu hết người dùng đều quen với giao diện người dùng mà họ nhìn thấy hoặc các tính năng họ sử dụng, nên điều này không dễ dàng đối với mọi người để quyết định liệu thứ gì đó thuộc về kỹ thuật hay phi kỹ thuật. Vì vậy, chúng tôi 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ự nhận thông tin qua điện thoại thông minh và nghỉ qua máy tính hoặc các thiết bị khác. Vì vậy, tài liệu cần phải dễ dàng điều chỉnh cho phù hợp với mọi kích thước màn hình. Và sẽ không gây nhầm lẫn về điều hướng.

-> Không phải mọi tính năng của phiên bản dành cho máy tính để bàn đều có sẵn trong cổng Android và nếu có thì không hoạt động như nhau ở 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 trong một thời gian dài hơn và đã đạt đến trạng thái bão hoà, ngược lại cổng 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 rất mạnh mẽ, nhưng vẫn có sự hạn chế rõ ràng về loại tính năng mà chúng ta có thể kết hợp chủ yếu là do nhu cầu của người dùng cuối. Nếu có một tính năng không ai sử dụng, bạn sẽ lãng phí tài nguyên phát triển. Vì vậy, bạn không nên chuyển đổi 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 trên máy tính đang sử dụng trình tạo Tài liệu Sphinx và giao diện Đọc tài liệu. Việc sử dụng tương tự cho cổng Android sẽ giúp ích cho chúng ta 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 điều hướng đến Tài liệu người dùng Android thông qua Tài liệu về máy tính

Tách các chương, mục và tiểu mục theo vị trí tương đối khi áp dụng. Ví dụ: Chế độ Nền/Hình trong hình nằm trong mục Thêm -> Cài đặt->Video, nên cấu trúc chương sẽ là

Thêm

|__Cài đặt

| |__Thư viện nội dung đa phương tiện

| |__Video -->Chế độ trong nền/Hình trong hình

: -> Phương pháp này sẽ giúp người dùng dễ dàng truy cập hơn vì người dùng có thể dễ dàng di chuyển đến vị trí họ cần trợ giúp bằng cách so sánh vị trí đó 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 các phần kỹ thuật và phi kỹ thuật. Trước tiên, chúng ta sẽ viết một phần mô tả dễ hiểu về mặt 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 tính năng đó, nếu có, ngay bên dưới tính năng đó. Điều này có thể dẫn đến một số lần 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 liên quan đến 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ì. Vì ứng dụng sẽ đạt đến trạng thái bão hoà nên giao diện người dùng tương đối không có khả năng thay đổi nhiều, vì vậy trong tương lai, nếu một tính năng mới được thêm/xoá, chúng ta chỉ cần tái cấu trúc phần đó. Trong trường hợp toàn bộ giao diện người dùng thay đổi, chúng tôi có thể sắp xếp lại các phần/chương hoặc sắp xếp lại toàn bộ tài liệu, dù trong trường hợp nào thì chúng tôi cũng 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ế cho phù hợp với giao diện người dùng hiện tại. Bản minh hoạ 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ả về tính năng, phần kỹ thuật khác (nếu có) cũng như các mẹo và thủ thuật dành cho tính năng đó.

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

-> Các cải tiến khác có thể bao gồm thiết kế lại trang chủ Tài liệu dành cho người dùng trên Máy tính để cho phép người dùng trực tiếp chọn hệ điều hành yêu thích của họ, sau đó chuyển hướng đến tài liệu của hệ điều hành đã chọn. Do tài liệu người dùng VLC của Windows, MacOS và Linux đã được thiết kế và trò chuyện rất tốt, chúng tôi có thể đưa ra các tuỳ chọn để lựa chọn trong số các lựa chọn là Windows/MacOS/Linux hoặc Android hoặc iOS. Điều này sẽ dẫn đến tài liệu người dùng hợp nhất nhưng được tách biệt độc đáo chỉ có một đường liên kết để sử dụng cho tất cả các cổng.

TẠI SAO TÔI ĐƯỢC ĐỀ XUẤT TÀI LIỆU NGƯỜI DÙNG ĐƯỢC ĐỀ XUẤT TỐT HƠN? Tài liệu dành cho người dùng mà bạn đề xuất này được xây dựng dựa trên các mẫu phổ biến mà người dùng cuối sẽ theo dõi để 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 cần thiết (ví dụ: Tính đơn giản, Sự rõ ràng, Giao diện, kiến thức công nghệ để tăng tối đa tính dễ sử dụng và trải nghiệm của người dùng cuối). Điều này cũng có thể dễ dàng bảo trì vì không cần phải duy trì tài liệu người dùng cá nhân cho mỗi cổng.

TẠI SAO TÔI PHÙ HỢP VỚI DỰ ÁN NÀY? -> Tôi đã viết mã được 2 năm và thường thì tôi cần phải xem tài liệu về API cho một số thư viện nhất định 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 nội dung mọi người muốn xem trong tài liệu này, vấn đề mà họ gặp phải và cách họ tiếp cận để được trợ giúp. Tôi có thể áp dụng trải nghiệm tương tự để viết một tài liệu nhất quán và dễ đọc.

-> Tôi đã tích cực viết nội dung kỹ thuật trên Quora, Stack Overflow và nhiều nền tảng khác nhau. Tôi biết cách giải thích mọi thứ 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, nhưng hầu hết các tính năng của VLC chưa được biết hoặc chưa có sự trợ giúp nào. Tôi đã sử dụng VLC trên cả nền tảng máy tính để bàn lẫn thiết bị di động được nhiều năm và tôi biết những vấn đề mà người dùng có thể gặp phải. Áp dụng tất cả kiến thức và kinh nghiệm của tôi, tôi có thể đảm bảo có một tài liệu tuyệt vời.