Идеи проекта

Текущая фаза:
Программа «Сезон документации 2019» завершилась 6 марта 2020 г. См . график .

Идеи проекта представляют собой предложения от организации с открытым исходным кодом для проектов, которые технический писатель может реализовать в сотрудничестве с наставником во время «Сезона документации».

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

Примеры проектов

Ниже приведены некоторые идеи о типе проекта, за который может взяться технический писатель:

  • Создайте сайт документации на платформе, которую определит технический писатель и наставник по открытому исходному коду, и опубликуйте на сайте первоначальный набор основных документов. Примеры платформ включают в себя:

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

  • Напишите концептуальный обзор или введение в продукт или функцию. Часто команда создает техническую документацию снизу вверх, в результате чего много деталей, но сложно понять продукт в целом. Технический писатель может это исправить.

  • Создайте руководство для громкого сценария использования.

  • Создайте набор конкретных практических руководств для конкретных задач.

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

Вышеупомянутые идеи намеренно различаются по объему и размеру. Продолжительность любого проекта зависит от ряда факторов, включая размер набора документации, сложность продукта, опыт технического писателя и наставников с открытым исходным кодом, инструменты и процессы, предлагаемые проектом с открытым исходным кодом. , и более.

Цель приведенного выше списка — помочь вам начать. Вы можете предложить и другие типы проектов.

Опубликуйте свой список идей проекта

Вам следует опубликовать идеи своего проекта на общедоступной веб-странице, в блоге или в каком-либо другом общедоступном документе.

Страница идей вашего проекта должна включать:

  • Информация о вашей организации с открытым исходным кодом:

    • Название организации.
    • Описание организации.
    • Ссылка на ваш репозиторий с открытым исходным кодом и/или веб-сайт.
    • (Необязательно) Адрес электронной почты для связи с вашей организацией по поводу Season of Docs. Он должен совпадать с адресом электронной почты, который вы указываете в форме заявки вашей организации на участие в Season of Docs.
    • (Необязательно) Информация об администрации и наставниках вашей организации, например их отображаемые имена. Они должны совпадать с отображаемыми именами, которые вы указываете в форме заявки вашей организации на участие в Season of Docs.

  • Объявление о том, что ваша организация подает заявку на участие в Сезоне документации в этом году. Страница продвижения и прессы содержит логотипы и другой контент, который вы можете использовать, рассказывая о Season of Docs.

  • Идея(ы) вашего проекта, включая информацию, описанную ниже для каждой идеи проекта.

Когда вы создаете заявку своей организации на Season of Docs, вам следует включить ссылку на страницу идей вашего проекта.

Информация в каждой проектной идее

Каждая идея проекта должна включать как минимум следующую информацию:

  • Название проекта: выберите краткое, но информативное название.
  • Описание: Более подробное описание необходимой документации. Подробно опишите свою первоначальную идею. Предложите возможность всем заинтересованным техническим писателям расширить или усовершенствовать идею.

  • Связанный материал:

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

Важность идей проекта

Идеи вашего проекта важны по нескольким причинам:

  • Работа над идеями поможет вашей организации сформулировать необходимые задачи по документации и подготовиться к работе с техническим писателем.
  • Идеи проекта дают администраторам программы Google представление о типе работы, которую будет выполнять технический писатель, когда они вступят в наставнические отношения с вашей организацией. Администраторы программы Google используют идеи проекта, чтобы оценить готовность организации участвовать в Season of Docs и наставлять технического писателя на протяжении всей программы.
  • Идеи проекта привлекают в вашу организацию заинтересованных технических писателей. Они могут использовать предложенные вами проекты в качестве основы для своих собственных проектных предложений.