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 Google Phần 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 lượng tiêu chuẩn (3 tháng)

Mô tả dự án

Mục tiêu:

  • Để tạo ra tài liệu người dùng cuối có chất lượng cao, được tạo phiên bản 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, không yêu cầu 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ạo tài liệu 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 những 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 có sẵn được trải rộng trên nhiều nguồn.
  • Thông tin khó tìm thấy và thường bị trùng lặp; rất dễ bị mất trong các trang không rõ ràng.
  • Bạn khó mà biết được thông tin nào là mới nhất và thông tin nào đã 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 |-- Liên hệ | |-- Vấn đề đã 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 kiếm hướng dẫn bắt đầu nhanh để bắt đầu nhanh nhất có thể. Mặc dù quá trình 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 nội dung 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 khi người dùng có thể không có nền tảng kỹ thuật vững chắc, người dùng cần có 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 nội dung 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 lên nền tảng mà người dùng đã chọn, đặc biệt khi đó không phải là nền tảng mà trò chơi nhắm đến.

  • Cách khởi chạy ScummVM, thêm trò chơi và khởi chạy 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 chiếu phải bao gồm những nội dung sau:

  • Giao diện Trình chạy; giao diện 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à trò chơi cụ thể.

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

  • Tuỳ chọn nâng cao:

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

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

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

  • Sự cố đã biết:

Phần này phải chứa mọi lỗi đã biết đối với 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 nếu bạn cung cấp bản tóm tắt 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ố lĩnh vực 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ễ dàng nhất để tôi lấy được thông tin mình cần từ các nhà bảo trì/nhà phát triển cổng (đặc biệt khi thông tin này chỉ mới có ít hoặc không tồn tại). Tôi sẽ điền sẵn mọi thông tin tôi đã có trong tài liệu hiện có. Sau đó, tôi có thể kiểm tra tính đầy đủ, tính chính xác và đơn vị tiền tệ hoặc bổ sung thông tin vào khi cần.

Tiếp theo, tôi sẽ soạn thảo tài liệu hiện có; README, wiki và trang web. Trong quá trình 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, đồng thời lấy 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 sau khi cổng thông tin hoạt động, sẽ không có dữ liệu trùng lặp, mâu thuẫn hay điểm 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 nào khác trong nhiều lĩnh vực để tìm nguồn thông tin còn thiếu, đồng thời đảm bảo mỗi trang đều mới nhất và đầy đủ nhất có thể.

Trên tinh thần cộng tác và phụ thuộc vào sự chấp thuận của(các) cố vấn, tôi muốn cộng đồng ScummVM có thể truy cập vào cổng công việc đang trong quá trình viết bài, qua đó 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 viết.

Bạn nên sử dụng hướng dẫn văn phong, chẳng hạn như hướng dẫn văn phong cho 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ể, tôi sẽ sử dụng ảnh chụp màn hình, ảnh GIF và các hình ảnh trực quan khác để tăng cường sự hiểu biết.

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

Gắn kết cộng đồng Từ 17/8 đến 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 nói chung để tinh chỉnh tầm nhìn cho dự án và hoàn thiện các chi tiết như cấu trúc và nội dung tài liệu.

Tuần 1 Từ 14/9 đến 20/9

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

Tuần 2 Từ 21/9 đến 27/9

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

Tuần 3 Từ ngày 28/9 đến ngày 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 dưới dạng 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 dưới dạng các mẫu đã hoàn tất được trả lại cho tôi

Tuần 5 12/10 – 18/10

Tuỳ chọn nâng cao: – Đám mây 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 được trả lại 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 dành riêng cho nền tảng 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 dành riêng cho nền tảng dưới dạng 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 dành riêng cho nền tảng vì 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 như điều hướng thanh bên, chỉnh sửa giao diện/CSS, v.v.
  • Đảm bảo tất cả đường liên kết đều hoạt động như dự kiến.
  • Kiểm tra để đảm bảo hình ảnh/gif hiển thị chính xác.

Tuần 11 Từ 23/11 đến 30/11

  • Hãy hoàn tất những vật phẩm còn tồn đọng và chính thức ra mắt cổng thông tin!
  • Sau khi ra mắt cổng thông tin, 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) cố vấn viên.