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 tài liệu của Google.
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 thông tin tài liệu
- Thời lượng dự án:
- Thời hạn tiêu chuẩn (3 tháng)
Mô tả dự án
Mục tiêu:
- Để tạo tài liệu chất lượng cao, có phiên bản cho người dùng cuối bằng cách hợp nhấ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à đầy đủ.
- Tài liệu phải dễ hiểu đối với người mới bắt đầu và không được tài trợ cho 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.
- Để đảm bảo tài liệu người dùng cuối luôn phù hợp với tương lai bằng cách tạo các mẫu và hướng dẫn chi tiết về cách thực hiện cho những người đóng góp nguồn mở trong tương lai.
Tình hình hiện tại:
- Tài liệu hiện có về ScummVM được phân phối trên nhiều nguồn.
- Thông tin khó tìm và thường bị trùng lặp; người dùng dễ bị lạc trong các trang không rõ ràng.
- Bạn khó mà biết được thông tin nào 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 đủ.
Cách 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
|-- Nhạc và âm thanh
|-- Trợ giúp
| |-- Câu hỏi thường gặp
| |-- Thông tin liên hệ
| |-- Các 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 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 đề cập đến 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à chạy trò chơi.
Cài đặt ScummVM:
Trong trường hợp quá trình cài đặt không trực quan hoặc người dùng có thể không có kiến thức 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 đã chọn, đặc biệt là 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à chạy trò chơi.
Sử dụng ScummVM:
Người dùng cần 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; giao diện của từng cửa sổ và thẻ cũng như cách hoạt động của các cửa sổ và thẻ đó.
- Nội dung giải thích về các chế độ cài đặt hiện có, cả chế độ chung và chế độ dành riêng cho trò chơi.
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 về các tuỳ chọn có sẵn để điều chỉnh cách chạy trò chơi.
- Lưu ý về trò chơi:
Mọi thông tin cụ thể 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 lỗi của bản cài đặt - Bất kỳ tệp bổ sung nào bắt buộc - Các chế độ kiểm soát bất thường hoặc khác
- Cá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 phân chia theo phiên bản, nhưng việc có một phần Ghi chú phát hành có thể hữu ích để tóm tắt các thay đổi trong bản phát hành mới nhất. Điều 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ễ nhất để tôi nhận được thông tin cần thiết từ các nhà bảo trì/nhà phát triển cổng (đặc biệt là khi thông tin này ít hoặc không có). Tôi sẽ điền sẵn mọi thông tin mà tôi có trong tài liệu hiện có. Sau đó, tôi có thể kiểm tra để đảm bảo thông tin đầy đủ, chính xác và đúng đơn vị tiền tệ hoặc bổ sung thông tin nếu cần.
Tiếp theo, tôi sẽ xem xét tài liệu hiện có; README, wiki và trang web. Trong quá trình này, tôi sẽ viết lại và thêm vào từng phần nếu cần, đồ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ẽ lưu ý đến những thông tin được lấy từ nguồn nào, để đảm bảo rằng sau khi cổng thông tin đi vào hoạt động thì không có tình huống lặp lại, 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) người cố vấn, nhà phát triển, người duy trì cổng và mọi chuyên gia khác về chủ đề này để tìm nguồn thông tin bị thiếu, cũng như đảm bảo mỗi trang luôn được cập nhật và đầy đủ nhất có thể.
Theo tinh thần cộng tác và tuân theo sự phê duyệt của(các) người cố vấn, tôi muốn cộng đồng ScummVM có thể truy cập vào cổng thông tin đang trong quá trình hoàn thiện trong suốt quá trình viết để nhận được ý kiến phản hồi theo thời gian thực và đảm bảo không bỏ lỡ điều gì trong quá trình này.
Bạn nên sử dụng hướng dẫn về văn phong, chẳng hạn như hướng dẫn về văn phong viết tài liệu cho nhà phát triển của Google, để đảm bảo tính nhất quán cho toàn bộ tài liệu này và cho tất 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 hỗ trợ trực quan khác để giúp bạn hiểu rõ hơn.
Tiến trình đề xuất:
Tạo mối liên kết cộng đồng Ngày 17 tháng 8 – 13 tháng 9 năm 2020
Tiếp tục dành thời gian trao đổi với(các) cố vấn và cộng đồng ScummVM rộng lớn hơn để 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 Ngày 14 tháng 9 – ngày 20 tháng 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 và phân phối cho đơn vị duy trì/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 thông tin 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 theo nền tảng dưới dạng mẫu đã hoàn tất sẽ được trả về cho tôi.
Tuần 4 Ngày 5 tháng 10 – ngày 11 tháng 10
Sử dụng ScummVM: - Cài đặt trò chơi - Lối tắt trên bàn phím Cài đặt ScummVM: - Hướng dẫn cài đặt dành riêng cho nền tảng dưới dạng mẫu đã hoàn tất sẽ được trả về cho tôi
Tuần 5 12/10 – 18/10
Tuỳ chọn nâng cao: - Đám mây và LAN - Ánh xạ điều khiển Cài đặt ScummVM: - Hướng dẫn cài đặt theo nền tảng khi các mẫu đã hoàn tất đượ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 từng nền tảng dưới dạng mẫu đã hoàn tất sẽ được trả về cho tôi
Tuần 7 26 tháng 10 – 1 tháng 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 sẽ được trả về cho tôi
Tuần 8 Ngày 2 tháng 11 – ngày 8 tháng 11
Trợ giúp: - Câu hỏi thường gặp - Thông tin liên hệ - Các vấn đề đã biết
Cài đặt ScummVM: – Hướng dẫn cài đặt theo nền tảng dưới dạng mẫu đã hoàn tất sẽ được trả về cho tôi
Tuần 9 Ngày 9 tháng 11 – ngày 15 tháng 11
Trợ giúp: - Báo cáo lỗi - Ghi chú về 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 Ngày 16 tháng 11 – Ngày 22 tháng 11
- Chỉnh sửa, đọc lại và hoàn tất 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, điều chỉnh 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/ảnh gif hiển thị chính xác.
Tuần 11 23/11 – 30/11
- Hãy hoàn tất mọi phần thưởng chưa xử lý 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 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.