На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Язык Джулии
- Технический писатель:
- Шуо Лю
- Название проекта:
- Документы LightGraphs 2.0 и удобные учебные пособия по JuliaGraphs
- Длина проекта:
- Длительный ход (5 месяцев)
Описание проекта
В этом долгосрочном проекте я буду улучшать сайт и документацию модулей в JuliaGraphs. В частности, моя работа будет включать, помимо прочего, следующее содержание.
LightGraphs Docs 2.0 – 10 недель
- Обзор: LightGraphs.jl — это оптимизированный облегченный пакет графов для Julia, который служит ядром экосистемы JuliaGraphs. Предстоящая версия LightGraphs 2.0 представляет собой фундаментальное изменение в API LightGraphs. Я позабочусь о том, чтобы в документации были представлены новейшие и лучшие возможности LightGraphs.
- Результаты: я проведу аудит существующей документации API, чтобы увидеть, какая документация может остаться прежней, и проанализирую изменения, внесенные в версию 2.0, чтобы убедиться, что они правильно задокументированы с примерами. В ходе этого процесса я буду писать статьи, освещающие основные изменения в версии 2.0. Чтобы помочь новичкам лучше понять LightGraphs, я создам руководства для начинающих для тех, кто делает первый шаг в мир использования графиков в Julia.
- Примечания. В этом проекте Documenter.jl будет использоваться в качестве генератора документов для создания документов LightGraphs. Помимо ссылок на API для таких модулей, как Coloring.jl, они также нужны мне для подмодулей, таких как greedy_color.jl. Я расскажу, как добавить их для обновления документации LightGraphs. Кроме того, теория графов — довольно техническая область математики, непонятная для тех, кто не имеет математического образования. Я занимаюсь академическими исследованиями около двух лет и написал много сообщений в блогах на своем личном сайте, поэтому я с уверенностью могу объяснить суть различных алгоритмов и дать подсказки, которые можно использовать в различных ситуациях при создании руководств для начинающих.
Уроки JuliaGraphs – 10 недель
- Обзор. Многие документы пакетов JuliaGraphs ориентированы на разработчиков. Я добавлю несколько простых примеров и проиллюстрирую использование каждой функции, чтобы сделать ее более доступной для пользователей.
- Результаты: я проведу аудит существующих руководств по LightGraphs, чтобы увидеть, какие материалы необходимо добавить, и продемонстрировать использование и мотивацию каждой функции. Затем я буду следовать примеру JuliaGraphsTutorials , чтобы расширить учебные пособия JuliaGraphs, включая руководство для начинающих в экосистеме LightGraphs.
- Примечания: Содержание JuliaGraphsTutorials в настоящее время недостаточно подробное, перечисленные выше результаты в основном относятся к пакету LightGraphs. Если позволит время, я также добавлю руководства для других модулей JuliaGraphs, таких как GraphPlot.jl , MetaGraphs.jl и SimpleWeightedGraphs.jl .
Центральный сайт JuliaGraphs – 4 недели
- Обзор: Центральный сайт JuliaGraphs предлагает обзор пакетов экосистемы. Однако в основном это по-прежнему описание, и его можно улучшить, чтобы оно стало первым ресурсом для людей, начинающих работу с графиками в Julia. Я собираюсь найти интуитивный способ визуализации, чтобы подчеркнуть особенности различных пакетов JuliaGraphs.
- Результаты: я предложу варианты использования и примеры, чтобы подчеркнуть функциональные возможности пакетов JuliaGraphs, и проведу аудит, чтобы убедиться, что они по-прежнему актуальны и поддерживаются. Я создам раздел, в котором будут освещены различные варианты использования различных пакетов в разных областях (здравоохранение, образование и т. д.). Если позволит время, я исследую визуальные объяснения алгоритмов, используемых в Graphs.
- Примечания: Многие пакеты JuliaGraphs широко используются в различных областях. Помимо расширений для построения графиков, таких как DiGraph для NetworkViz , я собираюсь включить некоторые другие приложения по конкретным предметам: MetaGraph для BioStructures в биологии, DijkstraState для TrafficAssignment в городском планировании , DiGraph для TreeView в образовании и т. д .