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ở:
- INCF
- Người viết nội dung kỹ thuật:
- hq
- Tên dự án:
- Tài liệu đào tạo của LORIS cho khoa học thần kinh tái tạo mở
- Thời lượng dự án:
- Chạy trong thời gian dài (5 tháng)
Mô tả dự án
I. Bản tóm tắt
Hệ thống hình ảnh và nghiên cứu trực tuyến theo chiều dọc (LORIS) là một nền tảng quản lý dự án trên web dành cho nghiên cứu hình ảnh thần kinh,hỗ trợ một số sáng kiến Khoa học mở. Tài liệu đóng vai trò quan trọng trong LORIS. Cụ thể, tài liệu giúp người dùng và nhà phát triển LORIS hiểu rõ thông tin chi tiết về phần mềm để có thể sử dụng nền tảng này hiệu quả hơn hoặc đóng góp vào quá trình phát triển phần mềm. Trong khi đó, tài liệu LORIS cũng cần được cập nhật. Dự án này nhằm giúp LORIS cải thiện tài liệu.
II. Trạng thái hiện tại
LORIS hiện sử dụng GitHub Wiki, Đọc tài liệu và trang web LORIS.ca để lưu trữ tất cả tài liệu. Cụ thể, LORIS GitHub Wiki lưu trữ lượng lớn tài liệu về LORIS và các hướng dẫn, bản trình bày, hướng dẫn sử dụng và hướng dẫn bổ sung về LORIS được lưu trữ trong nhiều nền tảng . Tài liệu LORIS hiện tại cung cấp hướng dẫn cho nhà phát triển và người dùng LORIS, nhưng tài liệu này có thể hưởng lợi từ việc phát triển và tổ chức hơn nữa, đặc biệt là về việc cập nhật tài liệu và cải tiến chi tiết kỹ thuật.
III. Lợi ích cho cộng đồng
Bằng cách cải thiện tài liệu đào tạo LORIS về khoa học thần kinh có thể tái tạo công khai, các nhà nghiên cứu và nhà phát triển sẽ được hưởng lợi từ một công cụ thân thiện hơn với người dùng để cải thiện việc thu thập dữ liệu trong các nghiên cứu của họ. Cụ thể, dự án có thể cập nhật và cải thiện tài liệu cài đặt/thiết lập LORIS, cũng như tài liệu dành cho người dùng cuối để đào tạo người dùng mới. Hơn nữa, dự án này sẽ giúp di chuyển và cập nhật tài liệu từ trang wiki GitHub của LORIS sang Read the Docs. Trong khi đó, dự án có thể cung cấp sơ đồ cơ sở dữ liệu để thông báo mối quan hệ dữ liệu và cải thiện khả năng trực quan hoá cấu trúc. Cuối cùng, dự án này sẽ cập nhật và cải thiện nội dung giới thiệu mọi người về LORIS, bối cảnh khoa học mở và các trường hợp sử dụng công nghệ này.
IV. Điểm mạnh cá nhân cho dự án
Trong vài năm qua, tôi đã tham gia một số dự án kỹ thuật, nhờ đó tôi có được nền tảng vững chắc về kỹ năng viết tài liệu kỹ thuật. Cụ thể, tôi từng chịu trách nhiệm viết tài liệu trong nhiều dự án nhóm trước đây và tôi tin rằng mình có đủ kinh nghiệm sử dụng các công cụ viết kỹ thuật như Read the Docs, Sphinx, Mkdocs, markdown, LaTeX, v.v. Ngoài ra, kinh nghiệm giảng dạy trước đây của tôi trong các khoá học STEM cũng giúp cải thiện kỹ năng giao tiếp kỹ thuật của tôi. Tài liệu đào tạo LORIS cho các dự án khoa học thần kinh có thể tái tạo mở với INCF sẽ là một cơ hội tuyệt vời để tôi áp dụng các kỹ thuật viết kỹ thuật của mình cho LORIS. Hơn nữa, tôi rất quan tâm đến lĩnh vực hình ảnh thần kinh và tôi đã cố gắng tìm cơ hội để áp dụng kiến thức kỹ thuật của mình cho lĩnh vực này. Tài liệu đào tạo của LORIS cho các dự án khoa học thần kinh có thể tái tạo mở với INCF sẽ là một trải nghiệm có giá trị đối với tôi.
V. Sản phẩm
- Di chuyển và cập nhật tài liệu LORIS hiện tại
- Xem xét, cập nhật và cải thiện tài liệu về cách cài đặt/thiết lập LORIS, đồng thời bổ sung tài liệu còn thiếu trong tài liệu của người dùng cuối để đào tạo người dùng mới
- Giúp tạo sơ đồ cơ sở dữ liệu để truyền đạt mối quan hệ dữ liệu (ví dụ: chủ đề, lượt truy cập nghiên cứu) và cải thiện khả năng trực quan hoá cấu trúc
- Giúp cập nhật và cải thiện tài liệu về LORIS API
- Giúp cập nhật và cải thiện nội dung giới thiệu LORIS, bối cảnh khoa học mở và các trường hợp sử dụng, liên quan đến nhiều định dạng nội dung nghe nhìn
VI. Dòng thời gian
Tạo mối quan hệ gắn bó trong cộng đồng (17 tháng 8 – 13 tháng 9) a) Hoàn tất việc làm quen với phần mềm LORIS và quy trình làm việc của nhóm. b) Xem xét, cập nhật và cải thiện tài liệu cài đặt/thiết lập LORIS.
Tuần 1 (14/9 – 20/9) Cập nhật và di chuyển tài liệu LORIS từ trang wiki của GitHub sang Read the Docs.
Tuần 2 (21/9 – 27/9) a) Xem lại tài liệu hiện tại dành cho người dùng cuối LORIS. b) Bắt đầu lấp đầy những khoảng trống trong tài liệu dành cho người dùng cuối LORIS, cung cấp chương trình đào tạo cho người dùng mới dựa trên tài liệu hiện có.
Tuần 3 (28/9 – 4/10) Hoàn tất việc bổ sung thông tin còn thiếu trong tài liệu dành cho người dùng cuối của LORIS nhằm đào tạo người dùng mới.
Tuần 4 (5/10 – 11/10) a) Hiểu rõ cấu trúc cơ sở dữ liệu LORIS hiện tại. b) Bắt đầu triển khai sơ đồ cơ sở dữ liệu cho nền tảng LORIS.
Tuần 5 (12/10 – 18/10) a) Hoàn thành nhiệm vụ tạo sơ đồ cơ sở dữ liệu LORIS. b) Xem lại API LORIS hiện tại và bắt đầu cải thiện tài liệu API.
Tuần 6 (19/10 – 25/10) Tiếp tục cải thiện tài liệu về API LORIS.
Tuần 7 (26/10 – 1/11) Hoàn tất nội dung cải thiện tài liệu về LORIS API.
Tuần 8 (2/11 – 8/11) Xem lại nội dung hiện tại giới thiệu LORIS và bắt đầu cập nhật cũng như cải thiện ngữ cảnh khoa học mở.
Tuần 9 (9/11 – 15/11) Hoàn tất việc cập nhật và cải thiện ngữ cảnh khoa học mở trong nội dung giới thiệu LORIS.
Tuần 10 (16/11 – 22/11) Giúp cập nhật và cải thiện một phần các trường hợp sử dụng trong nội dung giới thiệu LORIS.
Tuần 11 (23/11 – 29/11) Hoàn tất việc cập nhật và cải thiện tất cả các trường hợp sử dụng trong nội dung giới thiệu LORIS.
Hoàn tất dự án (30 tháng 11 – 5 tháng 12) a) Dọn dẹp tất cả nội dung đóng góp về tài liệu mà tôi đã tạo. b) Hợp nhất tất cả các yêu cầu kéo đã tạo trên GitHub và đóng tất cả các vấn đề mà tôi đã tạo. c) Hoàn tất báo cáo dự án cuối cùng và gửi báo cáo cho Google.
VII. Nội dung cần cung cấp trong tương lai
Sau Google Season of Docs 2020, tôi muốn tiếp tục đóng góp cho tài liệu về LORIS. Cụ thể, tôi muốn thảo luận với các nhà phát triển LORIS về khả năng tiếp tục cập nhật và tạo tài liệu cho các bản phát hành mới. Ngoài ra, tôi muốn dành thêm thời gian để xem lại tài liệu mà tôi đã tạo trong dự án Google Season of Docs và kiểm tra xem có thể cải thiện thêm không. Cuối cùng, vì có nền tảng kỹ thuật phù hợp, nên tôi sẵn sàng đóng góp cho các khía cạnh khác của phần mềm LORIS trong tương lai, chẳng hạn như phát triển phần mềm.