Проект Фонда геопространственных данных с открытым исходным кодом

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

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

Организация с открытым исходным кодом:
Геопространственный фонд с открытым исходным кодом
Технический писатель:
фликстар
Название проекта:
Обзор кратких руководств OSGeoLive
Длина проекта:
Стандартная продолжительность (3 месяца)

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

Цель

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

Аудитория

  • Новые пользователи OSGeo в прямом эфире
  • Авторы новых кратких руководств OSGeo Live

Доставка

  • Вики

Вот что я думаю нужно сделать:

  1. Просмотрите 50 существующих кратких руководств OSGeo Live.
  2. Разметка с правками. Отправьте на рассмотрение.
  3. Реализация обзора/обратной связи
  4. Создайте шаблон быстрого запуска, чтобы обеспечить согласованность в будущем.
  5. Обновите «Как выполнить процедуру быстрого запуска».
  6. Добавляйте новые приложения в OSGeoLive — им нужны быстрые старты.

Что я предлагаю сделать:

  • Просмотрите 50 существующих кратких руководств OSGeo Live и внесите изменения, используя эти страницы в качестве справочного материала:

    Новое: https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20quickstart%20file .

    Старая версия: https://wiki.osgeo.org/wiki/OSGeoLive_AddProject#Documentation .

  • Создание проблем с документацией в trac (отслеживание проблем)

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

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

  • Обновите страницу «Как документировать файл быстрого запуска».

Что вас ждет в конце SoD:

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

С чего я начну:

  • Посмотрите таблицу пакетов OSGeo-Live, чтобы узнать, какие пакеты изменились между выпусками.
  • Спросите в списке рассылки OSGEo Live, есть ли у них предложения по конкретным кратким руководствам для начала.

Что я уже сделал:

  • Настройте мою виртуальную машину и установите OSGeoLive.
  • Разветвлен репозиторий OSGeoLive-Doc.
  • Получил доступ к trac и проверил некоторые существующие заявки на документацию. Билет №1382 выглядит актуальным: https://trac.osgeo.org/osgeolive/ticket/1382.
  • Участвовал в обсуждениях в списке рассылки
  • Было несколько неофициальных видеочатов