На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- ЦЕРН-HSF
- Технический писатель:
- УдачаВДожде
- Название проекта:
- Расширение и улучшение документации ROOT
- Длина проекта:
- Длительный ход (5 месяцев)
Описание Проекта
Целью проекта является улучшение документации ROOT, которая является основной программной системой для анализа и представления данных, используемой сообществом физиков высоких энергий во всем мире.
Помимо навыков технического писателя, которые я могу предоставить для проекта, я также знаком с ROOT (6 и 7) и обладаю знаниями о других компонентах, необходимых для проекта, таких как:
- С++
- Питон
- Git/GitHub
- Инструменты создания веб-сайтов (html, markdown, Jekyll)
Я выделяю три основные части документации ROOT:
- веб-сайт https://root.cern,
- справочное руководство по классам C++ https://root.cern/doc/master/,
- форум https://root-forum.cern.ch
Мне кажется, ROOT-документацию (новое "ROOT-руководство") необходимо улучшить и дополнить по следующим направлениям:
- Оно должно стать более доступным и понятным для нефизиков, особенно вводные главы.
- Должны быть разработаны дополнительные руководства, объясняющие общую функциональность ROOT.
- Некоторые новые темы и разработки будут включены с подробными описаниями и примерами. Среди них я могу перечислить:
- Привязка Python
- Математические библиотеки
- Описание руководства для графических инструментов высокого уровня (TRatioPLot, THStack)
- Новые инструменты анализа данных (RDataFrame и RNtuple).
- Новые ключевые форматы данных (RDataFrame и RNtuple) требуют подробных технических спецификаций и учебных пособий.
Ответы на важные вопросы пользователей, например, размещенные на ROOT-форуме, необходимо будет включить в документацию. Это требует тщательного анализа наиболее часто задаваемых вопросов с последующим периодом синтеза для перевода их в фрагменты документации в новом «КОРНЕВОМ Руководстве» или в некоторых новых руководствах Справочного руководства.
Учебники, иллюстрирующие функциональные возможности ROOT 7.
- Новые гистограммы ROOT 7
- Новая графика ROOT 7
Ориентировочный график (5 месяцев):
- Этап 1: Определение задач и объема документации и учебных пособий ROOT: 2 недели.
- Этап 2. Сбор и анализ важных вопросов пользователей с ROOT-форума: 2 недели.
- Этап 3: Написание ROOT-документации: 8 недель.
- Этап 4. Разработка учебных пособий: 8 недель.
Наконец, я должен добавить, что в прошлом году я уже внес свой вклад в документацию ROOT в рамках долгосрочного проекта Google Season of Docs. Я определил новую структуру Руководства. Предложение этого года будет способствовать завершению других аспектов документации, которые все еще отсутствуют в ROOT.