Giai đoạn hiện tại:
Kết quả đã công bố
tiến trình.
Trang này dành cho các tổ chức nguồn mở đang ở giai đoạn khám phá trong quy trình đăng ký của tổ chức. Những ý tưởng dự án này chỉ là ví dụ cho thấy cách các tổ chức có thể mô tả các dự án tài liệu trên trang ý tưởng dự án của tổ chức; các tổ chức có thể đề xuất các dự án không có trong danh sách này.
Ý tưởng dự án: tạo hướng dẫn bắt đầu dành cho cộng tác viên
Vấn đề
- Cộng tác viên mới không thể tìm thấy thông tin thiết lập họ cần để đóng góp nội dung có ý nghĩa cho dự án của chúng tôi. Một số quy trình (chẳng hạn như đóng góp cho các thử nghiệm của chúng tôi) không được ghi lại.
Chúng tôi đo lường mức độ thành công như thế nào?
- Mức tăng số lượng cộng tác viên mới
- Tăng số lượng người đóng góp mới không dùng mã (bằng cách giúp họ dễ dàng đóng góp tài liệu hoặc thử nghiệm hơn)
- Giảm số lượng vấn đề do cộng tác viên mới đưa ra
- Số lượng vấn đề đã xử lý được gắn thẻ "vấn đề tốt đầu tiên" gia tăng
Người viết nội dung kỹ thuật cần có những kỹ năng nào để có thể sử dụng dự án này?
- Phải có: Quen thuộc với GitHub (hoặc sẵn sàng làm việc thông qua các hướng dẫn của GitHub)
- Sẽ hữu ích hơn rất nhiều: Quen thuộc với trình chạy kiểm thử của chúng tôi để chạy các chương trình kiểm thử và cập nhật tài liệu về cách thực hiện
Tình nguyện viên
Khuyến khích các thành viên trong cộng đồng đăng ký giúp đỡ một số công việc, ví dụ:
- @JaneQDev, hãy giúp chúng tôi giải đáp những thắc mắc về chương trình thử nghiệm
- @ChenPCoder, rất vui được xem xét các yêu cầu lấy tài liệu
- @ErichJEngineer có thể hướng dẫn về quy trình đóng góp hiện tại cùng với tác giả kỹ thuật
Thông tin liên hệ
- Người viết nội dung kỹ thuật muốn thực hiện dự án này nên gửi email đến email@project. Vui lòng đính kèm các đường liên kết đến bài viết kỹ thuật hoặc danh mục/sơ yếu lý lịch/CV của bạn.
Ý tưởng dự án: viết hướng dẫn để sử dụng thư viện của chúng tôi với ...
Vấn đề
- Dự án của chúng tôi nhận được nhiều vấn đề do người dùng đặt ra khi cố sử dụng thư viện của chúng tôi bằng $TechX. Chúng tôi không có hướng dẫn rõ ràng về cách tích hợp với $TechX và công nghệ này có thể khá phức tạp!
Chúng tôi đo lường mức độ thành công như thế nào?
- Giảm số lượng sự cố được gắn thẻ "$TechnicalX"
- Tăng số lượng yêu cầu lấy dữ liệu từ những người đóng góp mới giúp chúng tôi khắc phục lỗi hoặc bổ sung vào tài liệu về $technologyX
- Các đường liên kết khác đến dự án của chúng tôi từ các dự án $đóng
Người viết nội dung kỹ thuật cần có những kỹ năng nào để có thể sử dụng dự án này?
- Thật tuyệt vời khi biết: Một chút quen thuộc với $technologyX
Tình nguyện viên
Khuyến khích các thành viên trong cộng đồng đăng ký giúp đỡ một số công việc, ví dụ:
- @JaneQDev, hãy giúp giải đáp những câu hỏi về $TechX
- @ChenPCoder, rất vui được xem xét các yêu cầu lấy tài liệu
Thông tin liên hệ
- Người viết nội dung kỹ thuật muốn thực hiện dự án này nên gửi email đến email@project. Vui lòng cung cấp đường liên kết đến bài viết kỹ thuật hoặc bộ hồ sơ công việc/sơ yếu lý lịch của bạn.
Ý tưởng dự án: sắp xếp lại tài liệu của chúng ta
Vấn đề
- Tài liệu của chúng tôi chứa quá nhiều nội dung và vô tổ chức. Nhiều người dùng từ bỏ việc cố gắng tìm câu trả lời trong tài liệu và chỉ nêu vấn đề hoặc đặt câu hỏi trên diễn đàn của chúng tôi. Các trang của chúng tôi không xuất hiện trong kết quả tìm kiếm ngay cả đối với những từ khoá có liên quan.
Chúng tôi đo lường mức độ thành công như thế nào?
- Cải thiện quy trình SEO cho tài liệu của chúng tôi
- Số lượng vấn đề được nêu ra trong những chủ đề được đề cập trong tài liệu giảm
- Tăng số lượng tài liệu đóng góp
Người viết nội dung kỹ thuật cần có những kỹ năng nào để có thể sử dụng dự án này?
- Sẽ hữu ích hơn rất nhiều: kinh nghiệm sắp xếp lại các bộ tài liệu lớn và thuần thục, hiểu biết về SEO
Tình nguyện viên
Khuyến khích các thành viên trong cộng đồng đăng ký giúp đỡ một số công việc, ví dụ:
- @ChenPCoder, rất vui được xem xét các yêu cầu lấy tài liệu
Thông tin liên hệ
- Người viết nội dung kỹ thuật muốn thực hiện dự án này nên gửi email đến email@project. Vui lòng cung cấp đường liên kết đến bài viết kỹ thuật hoặc bộ hồ sơ công việc/sơ yếu lý lịch của bạn.
Ý tưởng dự án: chạy bản sửa lỗi tài liệu
Vấn đề
- Chúng tôi có rất nhiều lỗi và vấn đề cũ liên quan đến tài liệu của chúng tôi. Cộng đồng của chúng tôi rất sẵn lòng đóng góp ý kiến và giúp dọn dẹp mọi thứ, nhưng chúng tôi cần một người nào đó sắp xếp và điều hành quá trình sửa lỗi trên thực tế.
Chúng tôi đo lường mức độ thành công như thế nào?
- Số lượng vấn đề liên quan đến tài liệu đã xử lý
- Tăng số lượng người đóng góp tài liệu và cộng tác viên mới
Người viết nội dung kỹ thuật cần có những kỹ năng nào để có thể sử dụng dự án này?
- Sẽ hữu ích hơn rất nhiều nếu bạn có: kinh nghiệm chạy tính năng sửa tài liệu
- Kỹ năng tổ chức tốt
Tình nguyện viên
Khuyến khích các thành viên trong cộng đồng đăng ký giúp đỡ một số công việc, ví dụ:
- @ChenPCoder có thể giúp sắp xếp video và trò chuyện để sửa lỗi, cũng như giúp tìm tình nguyện viên ở các múi giờ khác
Thông tin liên hệ
- Người viết nội dung kỹ thuật quan tâm đến việc triển khai dự án này nên gửi email đến email@project/mở một vấn đề/hỏi trong diễn đàn của chúng tôi. Vui lòng cung cấp các đường liên kết đến bài viết liên quan đến kỹ thuật hoặc bộ hồ sơ công việc/sơ yếu lý lịch của bạn.
Ý tưởng dự án: kiểm tra tài liệu
Vấn đề
- Chúng tôi không biết rõ trạng thái của tài liệu! Thật khó để ưu tiên cải thiện tài liệu vì chúng tôi không có lộ trình hoặc ý thức về vấn đề cấp bách nhất. Chúng tôi cũng có nhiều nội dung đã lỗi thời cần được xoá hoặc lưu trữ.
Chúng tôi đo lường mức độ thành công như thế nào?
- Tạo lộ trình tài liệu với sự phê duyệt chung của cộng đồng
- Giảm số lượng trang tài liệu lỗi thời hoặc không chính xác
Người viết nội dung kỹ thuật cần có những kỹ năng nào để có thể sử dụng dự án này?
- Sẽ hữu ích hơn rất nhiều khi: có kinh nghiệm kiểm tra tài liệu
Tình nguyện viên
Khuyến khích các thành viên trong cộng đồng đăng ký giúp đỡ một số công việc, ví dụ:
- @JaneQCoder, có thể giúp phối hợp trình bày lộ trình tài liệu trong cuộc họp cộng đồng của chúng ta
Thông tin liên hệ
- Người viết nội dung kỹ thuật quan tâm đến việc triển khai dự án này nên gửi email đến email@project/mở một vấn đề/hỏi trong diễn đàn của chúng tôi. Vui lòng cung cấp các đường liên kết đến bài viết liên quan đến kỹ thuật hoặc bộ hồ sơ công việc/sơ yếu lý lịch của bạn.
Thông tin liên quan
- Trang quảng cáo và báo chí bao gồm biểu trưng và nội dung khác mà bạn có thể sử dụng khi nói về Phần Tài liệu.
- Video này từ PyCon Australia 2017 đưa ra gợi ý về cách sắp xếp tài liệu để mọi người thấy hữu ích: Những điều không ai nói cho bạn biết về tài liệu của Daniele Procida.