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