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