Dự án Chat nhóm nguồn mở Zulip

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ở:

Cuộc trò chuyện của nhóm 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 hạn 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 trên cả hai. Một trong số đó là cải thiện chất lượng của zulip.readthedocs.io để những người đóng góp mới ít gặp phải sự nhầm lẫn và nghi ngờ hơn trong quá trình đóng góp. Lý tưởng nhất là kết quả sẽ là một lộ trình rõ ràng và súc tích từ lần đóng góp đầu tiên cho đến khi bạn làm quen với cách hoạt động của Zulip. Tôi cũng dự định làm việc 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 dễ hiểu hơn. Cả hai phần này đều có thể liên quan đến việc cập nhật/đơn giản hoá nội dung, sắp xếp lại các bài viết, thêm tài liệu còn thiếu cho nhà phát triển, cũng như viết/kiểm thử mã.

Dự án sẽ bao gồm 4 giai đoạn. Giai đoạn đầu tiên sẽ bao gồm các dự án làm quen nhỏ, công cụ chuẩn bị và hiểu rõ hơn về nhu cầu tài liệu hiện tại. Mục đích của giai đoạn 2 là sắp xếp, xác định và ưu tiên công việc phù hợp với các mục tiêu của Zulip vào mùa thu này. Sau đó, tôi sẽ chuyển sang giai đoạn triển khai dự án. Tôi sẽ trao đổi với các cố vấn và cộng đồng nhà phát triển còn lại của Zulip để nhận ý kiến phản hồi. Giai đoạn cuối cùng là xem lại, sửa đổi nếu cần và viết báo cáo dự án.

Tôi nghi ngờ một số ưu tiên và nhiệm vụ có thể thay đổi trong suốt thời gian làm việc do những gì mọi người khác đang làm; bao gồm cả quyết định của các nhà phát triển cốt lõi. Tôi cho rằng việc tìm hiểu cách thích ứng tốt với những thay đổi như vậy sẽ là một khía cạnh cần thiết để có trải nghiệm thành công với GSoD. Có thể đến một lúc nào đó, bạn nên hoãn các ý tưởng đã đề xuất để thực hiện sau. 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.