Dự án ScummVM

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ở:
ScummVM
Người viết nội dung kỹ thuật:
Cadi
Tên dự án:
Khởi chạy Cổng tài liệu
Thời lượng dự án:
Thời gian tiêu chuẩn (3 tháng)

Mô tả dự án

Mục tiêu:

  • Để tạo tài liệu có chất lượng cao, có nhiều phiên bản dành cho người dùng cuối bằng cách tổng hợp một lượng lớn thông tin từ các nguồn khác nhau và viết lại thông tin để đảm bảo tính rõ ràng, nhất quán và hoàn chỉnh.
  • Tài liệu phải dễ hiểu đối với người mới bắt đầu mà không quá phổ biến với những người dùng am hiểu công nghệ.
  • Cách tạo cổng tài liệu bằng trình tạo trang web tĩnh.
  • Để tài liệu dành cho người dùng cuối phù hợp với tương lai bằng cách tạo mẫu và hướng dẫn chi tiết cho các cộng tác viên nguồn mở trong tương lai.

Tình hình hiện tại:

  • Tài liệu ScummVM hiện có được trải rộng trên nhiều nguồn.
  • Thông tin rất khó tìm thấy và thường bị trùng lặp; rất dễ bị mất trong các trang ít người biết đến.
  • Khó biết được thông tin nào là mới nhất và thông tin nào là lỗi thời.
  • Một số thông tin bị thiếu hoặc không đầy đủ.

Khắc phục vấn đề:

Cấu trúc tài liệu đề xuất:

Trang đích |-- Bắt đầu | -- Quick start guide |-- Installing ScummVM | |-- Nintendo 3DS | |-- AmigaOS | |-- Android | |-- (every) | |-- (common) | |-- (supported) |-- (nền tảng) |-- Sử dụng ScummVM | |-- Trình chạy | |-- Cài đặt chung | |-- Cài đặt trò chơi | -- Keyboard shortcuts |-- Advanced options | |-- Cloud and LAN | |-- Control Mapping | |-- Configuration | |-- Command line options | |-- Graphics |-- Âm nhạc và âm thanh |-- Trợ giúp | |-- Câu hỏi thường gặp | |-- Danh bạ | |-- Sự cố đã biết | -- Reporting a bug |-- Game Notes-- Ghi chú phát hành

  • Bắt đầu:

Người dùng mới thường tìm hướng dẫn bắt đầu nhanh để bắt đầu nhanh nhất có thể. Mặc dù việc cài đặt ScummVM có thể phức tạp trên một số nền tảng, nhưng việc cài đặt ScummVM trên máy tính thì không.

Hướng dẫn bắt đầu nhanh phải bao gồm những thông tin sau:

  • Cách cài đặt ScummVM trên Windows, Mac và Linux.

  • Cách tải, thêm và khởi chạy trò chơi.

  • Cài đặt ScummVM:

Trong trường hợp việc cài đặt không trực quan hoặc nơi người dùng có thể không có cơ sở kỹ thuật vững mạnh, người dùng cần hướng dẫn toàn diện để cài đặt ScummVM trên bất kỳ nền tảng nào được hỗ trợ.

Mỗi trang cài đặt toàn diện phải bao gồm những thông tin sau:

  • Mọi yêu cầu/điều kiện tiên quyết về hệ thống.
  • Cách tải phiên bản ScummVM phù hợp xuống.
  • Cách cài đặt ScummVM.
  • Cách tải trò chơi trên nền tảng đã chọn, đặc biệt khi đó không phải là nền tảng mà trò chơi được thiết kế.

  • Cách chạy ScummVM, thêm trò chơi và ra mắt trò chơi.

  • Sử dụng ScummVM:

Người dùng cần có tài liệu tham khảo giải thích cách sử dụng ScummVM.

Tài liệu tham khảo phải bao gồm những nội dung sau:

  • Giao diện Trình chạy; hình thức của từng cửa sổ và thẻ cũng như cách hoạt động của chúng.
  • Nội dung giải thích về các chế độ cài đặt có sẵn, cả chung và riêng cho trò chơi.

  • Phím tắt/phím nóng.

  • Tùy chọn nâng cao:

Người dùng thành thạo cần có thêm thông tin kỹ thuật và bổ sung về các tuỳ chọn mà họ có thể dùng để điều chỉnh cách chạy trò chơi.

  • Ghi chú của trận đấu:

Mọi thông tin riêng về trò chơi mà người dùng cần biết; bao gồm nhưng không giới hạn ở: – Các yếu tố tương tự khi cài đặt – Yêu cầu tệp bổ sung – Chế độ kiểm soát bất thường hoặc khác

  • Vấn đề đã biết:

Phần này phải chứa mọi lỗi đã biết dành riêng cho bản phát hành.

  • Ghi chú phát hành:

Mặc dù tài liệu của chúng tôi sẽ được tạo phiên bản, nhưng phần Ghi chú phát hành có thể hữu ích để cung cấp nội dung tóm tắt về các thay đổi trong bản phát hành mới nhất. Nội dung này có thể bao gồm một số nội dung hiện nằm ngoài phạm vi của tài liệu này, chẳng hạn như các trò chơi mới được hỗ trợ hoặc thông tin về các công cụ mới.

Kế hoạch tấn công:

Tôi đề xuất bắt đầu bằng cách tạo một mẫu cho các trang Cài đặt ScummVM, vì đó sẽ là cách dễ nhất để tôi có được thông tin mà tôi yêu cầu từ những nhà phát triển/nhà bảo trì cổng (đặc biệt là khi thông tin này rất ít hoặc không tồn tại). Tôi sẽ điền sẵn mọi thông tin đã có từ tài liệu hiện có. Sau đó, thông tin này có thể được kiểm tra tính đầy đủ, tính chính xác và đơn vị tiền tệ hay thêm vào khi cần.

Tiếp theo, tôi sẽ phác thảo tài liệu hiện có; README, wiki và trang web. Trong khi thực hiện, tôi sẽ viết lại và thêm vào từng phần theo yêu cầu, sau đó thu thập tất cả thông tin vào cổng thông tin mới. Tôi cũng sẽ ghi lại thông tin được lấy từ đâu, để đảm bảo rằng khi cổng thông tin hoạt động sẽ không có sự trùng lặp, mâu thuẫn hoặc bất thường khác.

Trong suốt quá trình này, tôi sẽ liên hệ với(các) cố vấn, nhà phát triển, nhà bảo trì cổng và bất kỳ chuyên gia trong ngành nào khác để tìm hiểu mọi thông tin còn thiếu, cũng như đảm bảo mỗi trang đều là mới nhất và đầy đủ nhất có thể.

Trên tinh thần cộng tác và phải được(các) người cố vấn chấp thuận, tôi muốn cộng đồng ScummVM có thể truy cập cổng công việc đang tiến hành này trong quá trình soạn thảo nội dung, để nhận phản hồi theo thời gian thực và đảm bảo không bỏ sót điều gì trong quá trình này.

Bạn nên sử dụng một hướng dẫn về quy tắc lập trình, chẳng hạn như hướng dẫn về quy tắc lập trình tài liệu dành cho nhà phát triển của Google, để đảm bảo tính nhất quán cho nội dung này và cho tất cả các tài liệu sau này.

Bất cứ khi nào có thể, em sẽ sử dụng ảnh chụp màn hình, ảnh GIF và các hình ảnh hỗ trợ trực quan khác để ôn lại kiến thức.

Tiến trình đề xuất:

Gắn kết cộng đồng 17/8 – 13/9/2020

Hãy tiếp tục dành thời gian trao đổi với(những) người cố vấn và cộng đồng ScummVM rộng lớn để điều chỉnh tầm nhìn cho dự án và hoàn thiện những chi tiết như cấu trúc và nội dung tài liệu.

Tuần 1 14/9 – 20/9

  • Tạo mẫu cho các trang cài đặt theo nền tảng cụ thể.
  • Điền sẵn mọi thông tin hiện có vào mẫu và phân phối cho các nhà bảo trì/nhà phát triển cổng thích hợp để biết thêm thông tin.

Tuần 2 21/9 – 27/9

  • Thiết lập cổng tài liệu mới.

Tuần 3 28/9 – 4/10

Sử dụng ScummVM: – Giao diện – Cài đặt chung Cài đặt ScummVM: – Hướng dẫn cài đặt dành riêng cho nền tảng, khi các mẫu đã hoàn tất sẽ được trả lại cho tôi.

Tuần 4 5/10 – 11/10

Sử dụng ScummVM: – Cài đặt trò chơi – Phím tắt Cài đặt ScummVM: – Hướng dẫn cài đặt dành riêng cho nền tảng, khi các mẫu đã hoàn tất sẽ được trả lại cho tôi

Tuần 5 12/10 – 18/10

Tuỳ chọn nâng cao: – Cloud và LAN – Kiểm soát ánh xạ Cài đặt ScummVM: – Hướng dẫn cài đặt dành riêng cho nền tảng khi các mẫu đã hoàn tất sẽ được trả về cho tôi

Tuần 6 19/10 – 25/10

Tuỳ chọn nâng cao: – Cấu hình – Tuỳ chọn dòng lệnh Cài đặt ScummVM: – Hướng dẫn cài đặt theo nền tảng cụ thể khi các mẫu đã hoàn tất được trả lại cho tôi

Tuần 7 26/10 – 1/11

Tuỳ chọn nâng cao: – Đồ hoạ – Âm thanh Cài đặt ScummVM: – Hướng dẫn cài đặt theo nền tảng cụ thể khi các mẫu đã hoàn tất được trả lại cho tôi

Tuần 8 2/11 – 8/11

Trợ giúp: - Câu hỏi thường gặp - Danh bạ - Sự cố đã biết

Cài đặt ScummVM: – Hướng dẫn cài đặt theo nền tảng cụ thể khi các mẫu đã hoàn tất được trả lại cho tôi

Tuần 9 9/11 – 15/11

Trợ giúp: - Báo cáo lỗi - Ghi chú trò chơi - Ghi chú phát hành

Cài đặt ScummVM: – Hoàn tất mọi hướng dẫn về nền tảng chưa hoàn tất.

Tuần 10 16/11 – 22/11

  • Chỉnh sửa, hiệu đính và hoàn thiện mọi quyết định liên quan đến cổng thông tin, chẳng hạn như điều hướng thanh bên, chỉnh sửa chủ đề/CSS, v.v.
  • Đảm bảo tất cả đường liên kết đều hoạt động như mong đợi.
  • Kiểm tra xem hình ảnh/gif có hiển thị chính xác hay không.

Tuần 11 23/11 – 30/11

  • Hãy hoàn tất mọi vật phẩm còn tồn đọng và chính thức ra mắt cổng thông tin!
  • Sau khi cổng thông tin ra mắt, hãy xoá thông tin dư thừa khỏi các nguồn khác sau khi tham khảo ý kiến của(các) người cố vấn.