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