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ở:
- Kolibri
- Người viết nội dung kỹ thuật:
- StephDix
- Tên dự án:
- Quy ước về quy trình và kiểu tài liệu của hệ sinh thái Kolibri
- Thời lượng dự án:
- 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 tài liệu 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ề văn phong LE với các nguyên tắc về hỗ trợ tiếp cận, cách viết và định dạng được đề xuất theo các khái niệm và nguyên tắc định kiểu của LE trong quá trình phát triển phần mềm. Trong giai đoạn thứ hai, tôi sẽ kiểm tra chất lượng đối với 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ủ nguyên tắc về Kiểu. 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 thay đổi vào tài liệu. Trong giai đoạn thứ ba, tôi sẽ xem xét cấu trúc, giao diện và cảm quan 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, trong đó xác định từng danh mục mẫu thuộc 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ụ này. Đây là nhiệm vụ tạo mẫu để gửi các vấn đề về tài liệu để dễ dàng xác định khi 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 nhằm nâng cao trải nghiệm tiếp cận thông tin của họ.
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 cũng như cộng tác viên tạo tài liệu hiệu quả hơn và cộng tác tích cực trong cộng đồng. Cách triển khai này áp dụng cho ReadTheDocs và nhóm phụ tài liệu 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ễ tiếp cận và bố cục nhất quán. Duy trì việc duy trì các phương pháp đảm bảo chất lượng dựa trên tài liệu. Duy trì khả năng truy cập dễ dàng vào 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
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.
Dịch vụ 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 dự án. Những thông tin cô cung cấp cho tổ chức về khái niệm của tổ chức là ""Nguyên tắc"" và ""Hướng dẫn"" cũng như liên quan đến sự tồn tại của Hướng dẫn dành cho cộng tác viên đã giúp tôi sắp xếp các ý tưởng và dự thảo 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ề văn phong 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 buổ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ác câu trả lời trong 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 hành về Markdown và một số RestructureText. Tôi dự định đóng góp nội dung sửa lỗi trong tài liệu để tiếp tục tìm hiểu cú pháp. Tôi sẽ dùng Sharex để lấy ảnh và GIF. Tôi thích công cụ này vì nó kết xuất ở nhiều định dạng đầu ra. Tôi sẽ sử dụng Sơ đồ để lập sơ đồ và ấn bản hình ảnh. Phần mềm sơ đồ tích hợp tuyệt vời với GoogleTà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 tài liệu của Kolibri. Tôi phát hiện thấy lỗi ngữ pháp, lỗi chính tả, sự không nhất quán về bố cục, kiểu chữ, cách sử dụng hình ảnh và các đường dẫn tài liệu gây nhầm lẫn trong hầu hết tài liệu của dự án. Ví dụ: Trong Hướng dẫn sử dụng của Kolibri, mục 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 qua 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 vào mục “Khắc phục sự cố”, bạn phải tìm kiếm phần đó 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 dự án này, tôi đã phân tích hai tài liệu: Hướng dẫn về văn phong tài liệu sử dụng LE Kolibri và Nguyên tắc dịch thuật LE. Trong Cẩm nang LE Kolibri, tôi đã đưa ra các đề xuất và nhận xét từ đề xuất chủ đề và kế hoạch tài liệu của mình 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 LE, tôi đã thay đổi định dạng và kiểu dựa trên các đề xuất và quy ước hiện có của tôi trên Hướng dẫn về văn phong. Trong quá trình phân tích, điều tôi chú ý nhất là một 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ả
Ngoài các nội dung đề xuất và nhận xét kèm theo biểu mẫu sơ bộ, tôi đã kiểm tra chất lượng của Hướng dẫn dịch thuật toán LE và 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 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 cách và sử dụng tính năng rút gọn sai. Sử dụng không đúng cách Văn bản thay thế. Lặp lại các câu lệnh/ hướng dẫn.
Các kết quả phát hiện cho cả hai tài liệu này đều nằm trong Nội dung đề xuất này.
Những việc cần làm theo dự án cụ thể
- Đề xuất về Hướng dẫn về quy tắc lập trình tài liệu người dùng LE (nhận xét)
- Nguyên tắc dịch LE với các kiểu và định dạng mới.
- Bố cục chủ đề
- Tiến trình dự án
- Các tác vụ liên quan đến tài liệu