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 Google Phần Tài liệu.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Kolbri
- Người viết nội dung kỹ thuật:
- StephDix
- Tên dự án:
- Quy ước và quy trình trong quy trình công việc và kiểu tài liệu về hệ sinh thái Kolibri
- Thời lượng dự án:
- Sử dụng lâu dài (5 tháng)
Mô tả dự án
Bản tóm tắt
Tài liệu này trình bày chi tiết việc triển khai Nguyên tắc về phong cách và quản lý quy trình công việc cho thông tin dạng văn bản của Learning Equality cho dự án Hệ sinh thái Kolibri.
Tổng quan
Đề xuất của tôi gồm 4 giai đoạn. Trong giai đoạn đầu, tôi sẽ hoàn thành Hướng dẫn về quy tắc lập trình LE để cung cấp các nguyên tắc hỗ trợ tiếp cận, cách viết và đề xuất định dạng dựa trên các khái niệm cũng như nguyên tắc về quy tắc lập trình LE trong quá trình phát triển phần mềm. Trong giai đoạn thứ hai, tôi sẽ thực hiện Kiểm tra chất lượng đối với các tài liệu ReadTheDocs và GoogleDocs. Kế hoạch kiểm tra kết hợp việc sử dụng danh sách kiểm tra để đánh giá việc tuân thủ các nguyên tắc về Văn phong. Các danh sách kiểm tra này sẽ giúp ghi lại những phát hiện và áp dụng các điểm thay đổi cho tài liệu. Trong giai đoạn thứ ba, tôi sẽ tìm hiểu cấu trúc, giao diện và cảm nhận của các mẫu trong tài liệu ReadTheDocs và GoogleDocs. Tôi sẽ tạo một kho lưu trữ mẫu và hình ảnh trong Google Drive, xác định từng danh mục mẫu của các loại tài liệu chính để sử dụng lại trong những lần triển khai sắp tới. Tôi sẽ bổ sung cho nhiệm vụ tạo mẫu này để gửi các vấn đề về giấy tờ để bạn dễ dàng nhận dạng trong quá trình xem xét yêu cầu lấy dữ liệu. Cuối cùng, tôi sẽ tạo Hướng dẫn dành cho cộng tác viên để nhóm các tài nguyên hữu ích cho từng nhóm cộng tác viên để nâng cao trải nghiệm của họ khi tiếp cận thông tin.
Mục đích và phạm vi
Mục đích của kế hoạch triển khai này là cải thiện trải nghiệm của người dùng cuối khi sử dụng tài liệu của Kolibri, đồng thời giúp các thành viên trong nhóm và người đóng góp soạn thảo tài liệu hiệu quả hơn và tích cực cộng tác trong cộng đồng. Cách triển khai này áp dụng cho ReadTheDocs và các nhóm tài liệu con của Google Tài liệu trong Hệ sinh thái Kolibri.
Đối tượng người xem
Đối tượng chính gồm người triển khai, quản trị viên và người dùng cuối là những người sử dụng quan trọng nhất của tài liệu Kolibri. Đối tượng phụ gồm các thành viên trong nhóm và cộng tác viên để sản xuất và sử dụng tài liệu của Kolibri.
Mục tiêu
Hướng dẫn về văn phong và hệ thống quy trình làm việc cho Tài liệu về hệ sinh thái Kolibri mong muốn người dùng: Xây dựng tài liệu dễ hiểu bằng ngôn ngữ dễ hiểu và bố cục nhất quán. Duy trì các phương pháp đảm bảo chất lượng khi ghi nhận vào tài liệu. Đảm bảo dễ dàng truy cập thông tin giữa các kênh tài liệu. Củng cố các sáng kiến cộng tác trong cộng đồng nguồn mở Kolibri.
Nguồn thông tin
Các nguồn thông tin của tôi là các tài liệu của Kolibri, Kolibri Studio, Kolibri Development RTD và Bộ công cụ Kolibri trên Google Drive.
Radina Matic tuyệt vời đã giúp ích rất nhiều trong việc tổ chức các hoạt động khởi động và hoạt động dành riêng cho từng dự án. Cô ấy đã đưa ra những khái niệm mà tổ chức coi là ""Nguyên tắc" và ""Hướng dẫn"" cũng như sự tồn tại của Hướng dẫn dành cho người đóng góp đã giúp tôi sắp xếp các ý tưởng và rút ra kết luận của mình.
Phần mềm
Tôi sẽ phát triển bản nháp Hướng dẫn về quy tắc trong Google Tài liệu. Nền tảng tài liệu này là lựa chọn hoàn hảo để lặp lại trong khi sẵn sàng xuất bản. Đối với Bài kiểm tra chất lượng, tôi sẽ sử dụng Google Biểu mẫu để tiến hành và đánh giá tài liệu. Bảng tính sẽ lưu trữ câu trả lời biểu mẫu để kiểm soát tài liệu. Tôi sẽ tái cấu trúc tài liệu RTD bằng GitHub. Tôi đã làm việc với Git, Gitkraken, GitHub và Gitlab. Tôi có kiến thức thực tế về Markdown và một vài RestructureText. Tôi dự định đóng góp bản sửa lỗi tài liệu để tiếp tục tìm hiểu cú pháp. Tôi sẽ sử dụng Sharex để tạo hình ảnh và ảnh GIF. Tôi thích công cụ này vì công cụ này kết xuất ở nhiều định dạng đầu ra. Tôi sẽ dùng biểu đồ để lập biểu đồ và phiên bản hình ảnh. Phần mềm sơ đồ tích hợp tuyệt vời với Google Tài liệu, Google Drive và LibreOffice. Trạng thái tài liệu Trong giai đoạn khám phá, tôi đã sửa đổi hầu hết các tài liệu của Kolibri. Tôi phát hiện có lỗi ngữ pháp, lỗi chính tả, sự không thống nhất về bố cục, kiểu chữ, cách sử dụng hình ảnh và ngoài ra, đường dẫn tài liệu khó hiểu trong hầu hết các tài liệu của dự án. Ví dụ: Trong Hướng dẫn sử dụng của Kolibri, phần khắc phục sự cố là chủ đề phụ chứ không phải chủ đề. Thông tin này vô cùng quan trọng để người dùng cuối có thể truy cập được từ mục lục. Giải pháp thứ hai là sử dụng thanh tìm kiếm và cây mục lục để mở rộng các chủ đề khác và tìm bài viết khắc phục sự cố.
Để truy cập mục "Khắc phục sự cố", bạn phải tìm kiếm mục này hoặc mở rộng "Quản lý Kolibri" để nhận thấy rằng Khắc phục sự cố có trong tài liệu. Hướng dẫn và Nguyên tắc Đối với đề xuất về dự án này, tôi đã phân tích hai tài liệu: Hướng dẫn về văn phong cho tài liệu sử dụng LE Kolibri và Nguyên tắc dịch thuật LE. Trong Hướng dẫn LE Kolibri, tôi đã đưa ra đề xuất và nhận xét dựa trên đề xuất chủ đề và kế hoạch Tài liệu cùng với một số điều khác cần cải thiện trong Hướng dẫn. Đối với Nguyên tắc dịch thuật LE, tôi đã thay đổi định dạng và phong cách dựa trên các đề xuất và quy ước hiện có trong Hướng dẫn về văn phong. Điều mà tôi chú ý nhất trong quá trình phân tích này là quan niệm sai lầm giữa các tài liệu được phân loại là Hướng dẫn và Nguyên tắc.
Kết quả
Tôi đã kiểm tra chất lượng của Hướng dẫn dịch LE, ngoài các đề xuất và nhận xét bằng biểu mẫu sơ bộ mà tôi giải thích chi tiết hơn trong nhiệm vụ Kiểm tra chất lượng. Sau đây là một số nhận xét cuối cùng thu được từ quá trình đánh giá: Đường liên kết bị hỏng cho trang web .js Cú pháp ICU Định dạng dùng để tạo các Nguyên tắc này không chính xác. Tài liệu này là Hướng dẫn, không phải Nguyên tắc. Kiểu chữ không nhất quán. Sử dụng tiêu đề và tiêu đề sai, Sử dụng ngôn từ không đúng và sử dụng tính năng thu gọn sai. Sử dụng sai Văn bản thay thế. Trên nội dung hướng dẫn/ tuyên bố lặp lại.
Các phát hiện cho cả hai tài liệu này đều là một phần của Sản phẩm cho đề xuất này.
Tác vụ cụ thể theo dự án
- Đề xuất trong Hướng dẫn về văn phong cho tài liệu người dùng LE (nhận xét)
- Nguyên tắc dịch thuật LE với phong cách và định dạng mới.
- Phác thảo chủ đề
- Tiến trình dự án
- Tác vụ liên quan đến tài liệu