На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- моя глобальная
- Технический писатель:
- Энтони
- Название проекта:
- Документация по коду инструмента отчетности
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание Проекта
Учитывая возможность документировать Инструмент отчетности для организации Moja Global, я предлагаю разработать 6 типов документации, которые будут использоваться разными аудиториями для достижения разных целей. Они кратко изложены ниже:
1)Руководство по настройке среды
1.1) Целевая аудитория Системные инженеры
1.2) Инженеры системы помощи Objective настраивают локальную среду сборки и выполнения для инструмента отчетов.
1.3) Формат. Статья с практическими рекомендациями, описывающая набор последовательных шагов, которые системные инженеры должны предпринять для настройки среды, которая будет способствовать созданию и использованию Инструмента отчетности.
2) Руководство по сборке
2.1) Целевая аудитория Системные инженеры
2.2) Инженеры системы Objective Help создают компоненты средства создания отчетов из исходного кода.
2.3) Формат. Статья с практическими рекомендациями, описывающая набор последовательных шагов, которые системные инженеры должны предпринять для получения и компиляции исходного кода средства отчетности.
3)Руководство по установке
3.1) Целевая аудитория Системные инженеры
3.2) Инженеры системы Objective Help устанавливают только что созданные компоненты Reporting Tool.
3.3) Формат. Статья с практическими рекомендациями, описывающая набор последовательных шагов, которые системные инженеры должны предпринять для развертывания средства создания отчетов в только что настроенной среде.
4)Руководство по эксплуатации
4.1) Целевая аудитория Системные интеграторы
4.2) Инженеры системы Objective Help запускают только что установленный экземпляр средства создания отчетов.
4.3) Формат. Статья с практическими рекомендациями, описывающая набор последовательных шагов, которые системные интеграторы должны предпринять для загрузки и обработки выходных баз данных Flux в работающем экземпляре средства отчетности.
Руководство по эксплуатации Внедрение и обработка баз данных выходных данных Flux в инструменте создания отчетов
5)Руководство пользователя
5.1) Целевая аудитория Конечные пользователи
5.2) Цель помощи. Конечные пользователи понимают различные функции, встроенные в Инструмент отчетности, и то, как эти функции следует использовать.
5.3) Формат Инструкционной статьи, в которой описывается набор последовательных шагов, которые Конечные пользователи должны предпринять для правильного использования Функциональности Инструмента отчетности.
6) Руководство по разработке
6.1) Программисты целевой аудитории
6.2) Цель помощи. Конечные пользователи понимают различные функции, встроенные в Инструмент отчетности, и то, как эти функции следует использовать.
6.3) Справочные статьи по формату, которые описывают: а) основные элементы дизайна, составляющие инструмент; б) функциональную декомпозицию вышеупомянутых элементов; в) элементы исполнения функционально декомпозированных элементов; г) исходный код инструмента/организацию библиотек; долгосрочное видение и направление постоянного улучшения f) логические следующие области для улучшения
И краткое руководство, описывающее, как можно адаптировать код к конкретным обстоятельствам пользователя.