GNOME Season of Docs 2020
GNOME подает заявку на участие в
Google Season of Docs 2020
Идеи проектов
GTK документация -
GTK API референсы состоят из двух частей: одна представляет собой описание каждой функции и типа в API; другой является более «повествовательным» и содержит общее описание каждого класса; обзор сложных, взаимозависимых классов (например, GtkTreeView, GtkTreeModel, GtkCellArea; или GtkTextView и GtkTextBuffer); краткое руководство по написанию приложения с использованием GTK. Эта вторая часть нуждается в рассмотрении и обновлении. Тон и структуру документации следует закрепить и сделать более подходящей для новичков в библиотеке
Улучшение GObject tutorial -
Документация по системе типов объектов GLib содержит обзор системы типов и базового класса объектов с темами, начиная от времени существования экземпляра объекта и заканчивая тем, как установить свойства; от интерфейсов до лучших методов написания типов объектов; и учебник, который охватывает аналогичные темы в более повествовательной форме. В идеале у нас должен быть только учебник, охватывающий все темы, и специальная, углубленная документация по более сложным аспектам API. Раздел базовых понятий должен быть объединен с разделом учебника, если первый раздел использует примеры и более повествовательный голос из второго.
Контент-аудит и анализ пробелов в gnome-help
Просмотрите все темы в gnome-help (часть модуля документации gnome-user-docs). Определите информацию, которая устарела или вводит в заблуждение. Просмотрите последние изменения в GNOME, чтобы найти области, в которых gnome-help отсутствует информация. После аудита и анализа пробелов должно быть время для серьезного написания, но мы не ожидаем, что технический писатель закроет все выявленные проблемы
Обновление приложения справки
Просмотрите и обновите справку для ряда приложений GNOME, которые отслеживаются в
тут