На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- OpenELIS Глобальный
- Технический писатель:
- Ариша
- Название проекта:
- Документация OpenELIS для конечных пользователей
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание Проекта
Мы стремимся перепроектировать и улучшить документацию для пользователей OpenELIS. I-TECH намерен произвести революцию в способах получения пользователями OpenELIS помощи в зависимости от их конкретных потребностей. В настоящее время инструкции по использованию OpenELIS содержатся в одном руководстве пользователя, навигация по которому может показаться пользователям утомительной и отнимающей много времени. Некоторые пользователи, особенно новые, ценят доступ к широкому спектру материалов, которые они могут просматривать и изучать по ходу дела. Другие пользователи, особенно те, кто более опытен и знаком с конкретным цифровым продуктом, таким как OpenELIS, захотят быстро найти и использовать определенный ресурс для выполнения задачи ввода данных или отчетности. Конкретные мероприятия будут включать:
Преобразование существующего (устаревшего) руководства пользователя в комплексную, обновленную библиотеку пособий и письменных руководств по всем текущим функциям (включая новые функции, такие как управление тестированием, сканирование штрих-кодов, пакетный ввод и импорт результатов анализатора). ), включая теги метаданных, помогающие индексировать информацию;
Разработать/обновить англоязычную версию справочных материалов.
Предоставление пользователям доступа к списку «Топ-10» наиболее часто используемых вспомогательных средств.
Создайте документ руководства по стилю и соглашениям по кодированию.