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ở:
- Django
- Tác giả kỹ thuật:
- Gabbyprecious
- Tên dự án:
- Viết lại hướng dẫn đóng góp để thân thiện với người dùng và dễ thao tác hơn
- Độ dài dự án:
- Thời gian tiêu chuẩn (3 tháng)
Mô tả dự án
ABSTRACT
Mục tiêu của hướng dẫn đóng góp của Django cũng giống như mọi tài liệu khác là hướng dẫn người dùng, những người đóng góp nguồn mở trong trường hợp này về cách thức và nơi họ có thể đóng góp để giúp Django trở nên tốt hơn và bền vững hơn.
Bạn luôn cần phải tạo tài liệu, đặc biệt là tài liệu ảnh hưởng lớn đến cộng đồng và chính Django.
Mục tiêu của Django trong Google Summer of Docs năm nay là giúp Hướng dẫn đóng góp trở nên dễ tiếp cận, dễ hiểu và thân thiện hơn với cộng tác viên. Đây là một mục tiêu thiết yếu vì nó khuyến khích những người đóng góp, trong đó có tôi, bắt đầu đóng góp cho khung tuyệt vời này.
Trạng thái hiện tại
Giai đoạn hiện tại của tài liệu mà bạn có thể thấy ở đây không thực sự là một hướng dẫn đầy đủ vì quá choáng ngợp và không có cấu trúc rõ ràng, dẫn đến việc thiếu hiểu biết về đóng góp ở Django và không chào đón những người đóng góp mới.
Mục tiêu dự án
Tôi đã thảo luận về những đề xuất về tài liệu với cố vấn Carlton Gibson trong diễn đàn và ông chấp thuận rằng gợi ý đó sẽ giúp giải quyết vấn đề khó giải quyết của tài liệu hiện tại. Sau đây là những mục tiêu tôi dự định tái cấu trúc tài liệu: Cấu trúc lại tài liệu Thêm những phần Việc nên làm và Không nên làm theo từng phần Tạo trang đơn cho những phần thông thường như Yêu cầu và tạo tính năng Giảm và đi thẳng vào tài liệu định nghĩa Bảng thuật ngữ về từ ngữ Chỉ mục nội bộ được tạo để tuân theo hướng dẫn mới Phân đoạn nội dung thành hai phần chính (phần Người mới bắt đầu và Người đóng góp nâng cao) Xây dựng hướng dẫn và phong cách kỹ thuật cho người viết và văn phong mới.
Tài liệu hiện tại đã nhắm đến những người đóng góp nâng cao và không tạo cơ hội cho những người đóng góp mới và người mới bắt đầu cả nguồn mở và Django, sau đây là một số nội dung bổ sung dành cho người mới bắt đầu: Phần hướng dẫn các nhóm người đóng góp khác nhau(nhà văn kỹ thuật, nhà thiết kế và nhà phát triển) Một trang ghi lại các vấn đề của người mới bắt đầu và các vấn đề dễ giải quyết. Lấy một vài phần trong tài liệu hiện tại, viết lại và thêm vào phần dành cho người mới bắt đầu. Các phần giải thích các điểm chính hoặc từ ngữ được sử dụng trong phần nâng cao.
Dòng thời gian
Dưới đây là thông tin chi tiết về cách tôi muốn thực hiện mục tiêu dự án như đã nêu ở trên bằng lịch do Google cung cấp.
Tuần gắn kết cộng đồng( 17 tháng 8 – 13 tháng 9) Tăng cường tương tác với cộng đồng Tiếp tục đóng góp cho tài liệu Nhận thêm đề xuất từ Cộng tác viên Tìm hiểu thêm về Tài liệu hiện tại và các công cụ dự kiến Tuần 1 – tuần 4 Bắt đầu chia tài liệu thành các phần dựa trên Cấp độ Tạo phần tài liệu dành cho người mới bắt đầu Tuần 4 – 6 Chọn lọc những việc nên và không nên làm Viết những việc nên và không nên làm theo phần Thêm trang cho các phần Tuần 7 – 9 Viết lại và chuyển tài liệu hiện tại sang Hướng dẫn dành cho cộng tác viên nâng cao Giảm bớt tài liệu Tuần 10 – 12 Chuẩn bị Bảng chú giải Cập nhật Chỉ mục nội bộ thành tài liệu mới Tạo hướng dẫn và phong cách cho các nhà văn/cộng tác viên kỹ thuật sắp tới
Công cụ
Sphinx – công cụ hiện tại cho tài liệu hiện tại. Đọc tài liệu.
Tại sao lại có dự án này?
Tôi tin tưởng rằng tài liệu và bài viết được viết tốt sẽ giúp mọi người ở một khu vực trên thế giới tiếp cận được. Ngoài ra, tôi cũng yêu thích Django và nguồn mở nói chung. Tôi muốn đóng góp cho Django với tư cách là một người mới bắt đầu và tôi nghĩ đây là một cách hoàn hảo để đóng góp cho công cụ yêu thích của mình, trong khi cũng làm quen với cơ sở mã để đóng góp nhiều hơn với tư cách là nhà phát triển(và người viết kỹ thuật). Sẽ thật dễ chịu và thú vị khi được làm việc với một tổ chức phù hợp với quan điểm của tôi, đồng thời cũng là một công cụ hữu ích cho toàn bộ sự nghiệp của tôi.
Tại sao tôi là người phù hợp cho dự án này?
Tôi tin rằng mình là người phù hợp dựa trên những lý do sau: Tôi đã đóng góp cho Django bằng cách viết các bài viết để giúp người mới bắt đầu hiểu rõ hơn về khái niệm Django. Là một nhà phát triển và cũng là người mong muốn đóng góp cho Django, tôi hiểu được nhu cầu của các nhà phát triển khác và cách ghi lại nhu cầu đó một cách hiệu quả cho họ. Tôi là một người chơi theo nhóm và sẽ làm việc hiệu quả dưới sự giám sát ít hoặc nhiều của người cố vấn Carlton Gibson.