Эта страница переведена с помощью Cloud Translation API.

проект ИНФФ

На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.

Краткое описание проекта

Организация с открытым исходным кодом:: ИНФФ
Технический писатель:: штаб-квартира
Название проекта:: Учебная документация LORIS по открытой воспроизводимой нейробиологии
Длина проекта:: Длительный ход (5 месяцев)

Описание проекта

I. Аннотация

Система продольных онлайн-исследований и изображений (LORIS) — это веб-платформа управления проектами для исследований в области нейровизуализации, поддерживающая несколько инициатив открытой науки. Документация играет важную роль в LORIS. В частности, документация помогает пользователям и разработчикам LORIS понять детали программного обеспечения, чтобы они могли лучше использовать платформу или внести свой вклад в разработку программного обеспечения. Между тем, документация LORIS также должна быть обновлена. Этот проект направлен на то, чтобы помочь LORIS улучшить документацию.

II. Текущее состояние

В настоящее время LORIS использует Github Wiki, Read the Docs и веб-сайт LORIS.ca для размещения всей документации. В частности, на LORIS GitHub Wiki размещено наибольшее количество документации LORIS, а дополнительные учебные пособия, презентации, руководства пользователя и пошаговые инструкции LORIS размещены на различных платформах. Текущая документация LORIS содержит руководства для разработчиков и пользователей LORIS, но ее дальнейшее развитие и организация могли бы быть полезны, особенно в плане обновлений документации и улучшения технических деталей.

III. Преимущества для сообщества

Совершенствуя учебную документацию LORIS по открытой воспроизводимой нейронауке, исследователи и разработчики получат более удобный инструмент для улучшения сбора данных в своих исследованиях. В частности, проект может обновить и улучшить документацию по установке/настройке LORIS, а также материалы для конечных пользователей, обеспечивающие обучение новых пользователей. Кроме того, проект будет направлен на помощь в миграции и обновлении документации из вики LORIS GitHub на Read the Docs. Между тем, проект может предоставить диаграмму базы данных для передачи взаимосвязей данных и улучшения визуализации архитектуры. Наконец, этот проект обновит и улучшит контент, знакомящий людей с LORIS, его открытым научным контекстом и вариантами его использования.

IV. Личные сильные стороны проекта

За последние несколько лет я участвовал в нескольких технических проектах, благодаря которым у меня появился солидный опыт технического письма. В частности, я отвечал за написание документации в нескольких прошлых командных проектах и считаю, что у меня достаточно опыта в использовании инструментов технического письма, таких как Read the Docs, Sphinx, Mkdocs, markdown, LaTeX и т. д. Между тем, мой предыдущий опыт преподавания в Курсы STEM также улучшили мои навыки технического общения. Учебная документация LORIS для открытых воспроизводимых нейробиологических проектов с INCF станет для меня прекрасной возможностью применить свои методы технического письма в LORIS. Более того, меня очень интересует область нейровизуализации, и я пытаюсь найти возможности применить свои технические знания в этой области. Учебная документация LORIS для открытых воспроизводимых нейробиологических проектов с INCF стала бы для меня ценным опытом.

V. Результаты

Перенос и обновление текущей документации LORIS.
Просматривать, обновлять и улучшать документацию по установке/настройке LORIS, а также заполнять пробелы в материалах для конечных пользователей, обеспечивая обучение новых пользователей.
Помогите создать диаграмму базы данных для передачи взаимосвязей данных (например, предмет, ознакомительный визит) и улучшить визуализацию архитектуры.
Помогите обновить и улучшить документацию LORIS API.
Помогите обновить и улучшить контент, знакомящий людей с LORIS, его открытым научным контекстом и вариантами его использования с использованием нескольких медиаформатов.

VI. Хронология

Объединение сообщества (17 августа – 13 сентября) a) Полное ознакомление с программным обеспечением LORIS и рабочим процессом команды. б) Обзор, обновление и улучшение документации по установке/настройке LORIS.

Неделя 1 (14 – 20 сентября) Обновление и перенос документации LORIS из вики GitHub в раздел Read the Docs.

Неделя 2 (21 сентября – 27 сентября) a) Просмотрите текущие материалы LORIS для конечных пользователей. б) Начать заполнять пробелы в материалах для конечных пользователей LORIS, обеспечивая обучение новых пользователей на основе текущей документации.

Неделя 3 (28 сентября – 4 октября) Заполнение пробелов в материалах для конечных пользователей LORIS и обучение новых пользователей.

Неделя 4 (5 октября – 11 октября) a) Понимание текущей архитектуры базы данных LORIS. б) Приступить к реализации схемы базы данных для платформы LORIS.

Неделя 5 (12 октября – 18 октября) a) Завершите задание по созданию диаграммы базы данных LORIS. б) Просмотрите текущий API LORIS и начните улучшать документацию API.

Неделя 6 (19 октября – 25 октября) Продолжение работы над улучшением документации LORIS API.

Неделя 7 (26 октября – 1 ноября) Завершить доработку документации LORIS API.

Неделя 8 (2 ноября – 8 ноября) Просмотрите текущий контент, знакомящий людей с LORIS, и начните обновлять и улучшать контекст открытой науки.

Неделя 9 (9 ноября – 15 ноября) Завершение обновлений и улучшений контекста открытой науки в содержании введения людей в LORIS.

Неделя 10 (16 – 22 ноября). Помогите обновить и улучшить часть вариантов использования в материалах, знакомящих людей с LORIS.

Неделя 11 (23–29 ноября) Завершите обновление и улучшение всех вариантов использования в содержании, знакомящем людей с LORIS.

Завершение проекта (30 ноября – 5 декабря) а) Очистите всю созданную мной документацию. б) Объединить все созданные запросы на извлечение на GitHub и закрыть все созданные мной проблемы. в) Закончить окончательный отчет по проекту и отправить его в Google.

VII. Будущие результаты

После Google Season of Docs 2020 я хотел бы продолжить работу над документацией для LORIS. В частности, я хотел бы обсудить с разработчиками LORIS возможность продолжения обновления и создания документации для новых выпусков. Более того, я хотел бы уделить немного дополнительного времени просмотру документации, которую я создал в ходе проекта Google Season of Docs, и проверить, есть ли еще возможности для улучшения. Наконец, поскольку у меня есть соответствующий инженерный опыт, я готов внести свой вклад в другие аспекты программного обеспечения LORIS в будущем, например, в разработку программного обеспечения.