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ở:
- Open Collective
- Người viết nội dung kỹ thuật:
- Anna e só
- Tên dự án:
- Cải thiện tài liệu trợ giúp chung
- Thời lượng dự án:
- Thời hạn tiêu chuẩn (3 tháng)
Mô tả dự án
Ấn tượng ban đầu Thường thì bạn sẽ thấy các trang tài liệu chứa hướng dẫn mà không có nội dung đa phương tiện hỗ trợ (video, ảnh GIF, hình ảnh) trong khi các phần khác trong cùng một chương có các mục đầy đủ hơn – ví dụ: Chỉnh sửa tập hợp tài sản chỉ bao gồm hướng dẫn trong khi Thêm máy chủ lưu trữ tài chính kết hợp nội dung đa phương tiện hỗ trợ.
Trong các trang mà tôi đã duyệt qua, không có nội dung nghe nhìn nào được mô tả bằng thuộc tính văn bản thay thế. Việc thiếu nội dung mô tả hình ảnh khiến người dùng không hiểu rõ về tài liệu đối với người sử dụng trình đọc màn hình và những người sử dụng kết nối Internet chậm hơn, nơi nội dung nghe nhìn có thể không tải được.
Một số phần của tài liệu hợp nhất các Câu hỏi thường gặp và hướng dẫn trực tiếp để điều hướng giao diện người dùng, chẳng hạn như Thay đổi máy chủ lưu trữ tài chính. Vì không có mục lục trong giao diện tài liệu, nên người dùng biết được hậu quả của việc thay đổi bản ghi đăng ký và chỉ muốn có hướng dẫn khách quan có thể coi tài liệu này là dài dòng và quá xa vời.
Mặc dù ngôn ngữ của tài liệu kỹ thuật khá nhất quán, nhưng Hướng dẫn về phong cách được cung cấp công khai lại cung cấp quá ít thông tin về cách viết tài liệu. Vì trang Đóng góp đề cập đến những đóng góp vào tài liệu kỹ thuật, nên cả cộng tác viên mở và cộng tác viên tiềm năng đều được hưởng lợi từ các nguyên tắc toàn diện hơn.
Đề xuất Tôi đề xuất đánh giá trang trợ giúp người dùng, xem xét lại cách trình bày và cấu trúc hiện tại của chúng.
Phương pháp và tiến trình Tôi muốn cải thiện tài liệu của Open Collective bằng cách làm việc cùng cộng đồng để thúc đẩy các chu kỳ phản hồi liên tục có thời lượng khác nhau.
Giai đoạn gắn kết cộng đồng (1 tháng 8 – 1 tháng 9 năm 2019): Làm quen với cộng đồng Open Collective! Phỏng vấn các thành viên tích cực của các dự án nổi bật và mới bắt đầu, hỏi họ về trạng thái hiện tại của tài liệu (Báo cáo #1). Ghi lại tất cả các hệ thống nội bộ dùng để theo dõi các truy vấn và vấn đề cũng như quy trình ghi lại các vấn đề đó trong Tài liệu Open Collective (Báo cáo #2). Đánh giá các vấn đề tiềm ẩn trong phiên bản tài liệu hiện tại và chuẩn bị kế hoạch giải quyết các vấn đề đó (Báo cáo #3).
Từ ngày 2 đến ngày 6 tháng 9: Chu kỳ phản hồi và điều chỉnh đầu tiên, có tính đến tất cả bình luận và đề xuất của cộng đồng trong khoảng thời gian gắn kết cộng đồng. Kế hoạch của chúng ta đã ổn chưa? Có điều gì cần thay đổi không? (Báo cáo số 4)
Ngày 9-20 tháng 9: Phát triển bằng chứng về khái niệm với chương tài liệu ít phổ biến hơn. Bản nháp của Hướng dẫn sử dụng công khai (Báo cáo #5).
Từ ngày 23 đến 25 tháng 9: Gửi bằng chứng về khái niệm để đánh giá (nhóm kín).
Ngày 26 và 27 tháng 9: Bản minh chứng khái niệm của chúng ta có cần điều chỉnh gì trước khi phát hành không? Chúng ta có cần thêm thời gian không? Điều chỉnh cho phù hợp. (Báo cáo #6)
Từ ngày 30 tháng 9 đến ngày 9 tháng 10: Phát hành bằng chứng về khái niệm. Chu kỳ phản hồi thứ hai (nhóm công khai).
10/10 – 15/10: Bằng chứng cuối cùng về việc đánh giá khái niệm và chu kỳ điều chỉnh. (Báo cáo #7)
Từ ngày 16 đến ngày 20 tháng 10: Nghỉ ngơi một chút [1].
Từ ngày 21 tháng 10 đến ngày 23 tháng 11: Hướng dẫn sử dụng kiểu chữ công khai đã hoàn thiện (Báo cáo #8). Áp dụng tất cả hướng dẫn có trong Hướng dẫn về kiểu cho tất cả các trang tài liệu dành cho người dùng (Báo cáo #9). Báo cáo đánh giá tất cả hoạt động đã thực hiện và các đề xuất khác cho cộng đồng (Báo cáo #10).
Thời lượng dự án có thể được gia hạn theo yêu cầu.
[1]: Chuyến đi được lên kế hoạch trước khi tôi đăng ký tham gia chương trình Mùa Tài liệu.
Sản phẩm phân phối - 10 báo cáo công khai về các hoạt động đã thực hiện - Một hướng dẫn quy tắc công khai mà cả Open Collective và cộng tác viên bên ngoài đều có thể sử dụng - Trang tài liệu người dùng được cải tiến