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ở:
- Cuộc trò chuyện nhóm sử dụng nguồn mở Zulip
- Người viết nội dung kỹ thuật:
- drrosa
- Tên dự án:
- Tái cấu trúc ReadTheDocs và API Tài liệu
- Thời lượng dự án:
- Thời gian tiêu chuẩn (3 tháng)
Mô tả dự án
Tôi sẽ tập trung vào hai lĩnh vực và làm việc song song với hai lĩnh vực đó. Một trong số đó là cải thiện chất lượng của zulip.readthedocs.io để những cộng tác viên mới ít gặp phải tình trạng nhầm lẫn và nghi ngờ hơn trong quá trình thực hiện. Lý tưởng nhất là kết quả thu được sẽ là một lộ trình rõ ràng và súc tích từ lần đóng góp đầu tiên đến việc làm quen với cách hoạt động của Zulip. Tôi cũng dự định nghiên cứu trên zulipchat.com/api, api.md và openapi.md để giúp quá trình ghi lại các điểm cuối bổ sung trở nên dễ hiểu hơn. Cả hai phần đều có thể liên quan đến việc cập nhật/đơn giản hoá nội dung, bài viết lộn xộn, thêm tài liệu còn thiếu dành cho nhà phát triển cũng như viết/kiểm thử mã.
Dự án này sẽ gồm 4 giai đoạn. Giai đoạn đầu tiên sẽ bao gồm các dự án làm quen với quy mô nhỏ, công cụ chuẩn bị và hiểu rõ hơn về nhu cầu liên quan đến tài liệu hiện tại. Mục đích của giai đoạn thứ hai là sắp xếp, xác định và ưu tiên công việc để đáp ứng các mục tiêu của Zulip trong mùa thu năm nay. Sau đó, tôi sẽ chuyển sang giai đoạn triển khai của dự án. Tôi sẽ liên hệ lại với các cố vấn cũng như những người khác trong cộng đồng nhà phát triển của Zulip để lấy ý kiến phản hồi. Giai đoạn cuối cùng là nhìn lại, sửa đổi nếu cần và viết báo cáo dự án.
Tôi nghi ngờ rằng một số mức độ ưu tiên và công việc có thể thay đổi trong suốt quá trình làm việc do hoạt động của những người khác; bao gồm cả quyết định của các nhà phát triển chính. Tôi hy vọng rằng việc tìm hiểu cách thích ứng tốt với những thay đổi đó sẽ là một khía cạnh cần thiết để có được trải nghiệm GSoD thành công. Có thể tại một thời điểm nào đó, bạn nên hoãn lại các ý tưởng được đề xuất trong tương lai. Nói chung, tôi sẽ tập trung vào việc đảm bảo công việc của mình mang lại giá trị cho thành công chung của dự án nguồn mở Zulip.