Проект Национального ресурса сетевой биологии (NRNB)

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

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

Организация с открытым исходным кодом:
Национальный ресурс сетевой биологии (NRNB)
Технический писатель:
Рахул Агравал
Название проекта:
Улучшение документации Cytoscape.Js
Длина проекта:
Стандартная продолжительность (3 месяца)

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

# Делаем документацию Cytoscape.js более доступной для новичков.

Согласно спецификации наставника, я разделил проект на две категории и хотел бы реализовать эти функции в этом проекте. Я расположил в порядке убывания приоритета.

  • Ключевые особенности (первый приоритет)

    - Фаза 1

  • Перенос существующей спецификации JSON со ссылками на файлы Markdown в комментарии JSDoc.

  • Уточнение и улучшение существующей документации, например написание лучшего описания или добавление дополнительных фрагментов кода.

    - Фаза 2

  • Написание новых руководств и создание видеороликов для освещения новых тем или более убедительного освещения основных тем.

    - Фаза 3

  • Написание новых демонстраций и видеороликов, чтобы дать представление о том, что представляют собой полноценные веб-приложения Cytoscape.

  • **Расширенные цели **

  • Некоторые общие улучшения документации.