На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- ФОЛИО
- Технический писатель:
- галлинита
- Название проекта:
- Расширение документации для конечных пользователей приложений FOLIO
- Длина проекта:
- Длительный ход (5 месяцев)
Описание Проекта
В рамках этого проекта я планирую работать над созданием и обновлением документации FOLIO, ориентированной на конечного пользователя. Поскольку ФОЛИО — это система управления библиотекой, конечным пользователем являются сотрудники библиотеки. В настоящее время вики-сайт ФОЛИО (https://wiki.folio.org/) содержит некоторую документацию, но она минимальна и не в удобочитаемом формате, созданном специально для сотрудников библиотеки. Новая документация, созданная в рамках этого проекта, будет размещена в специальной базе знаний документации, которая будет доступна из приложений FOLIO и будет содержать рабочие процессы, относящиеся к системе и пользователям ее библиотеки. На сайте будет опубликован первоначальный набор документации, начиная с функциональности тиража и резервов курса. Я хотел бы внести как можно больший вклад в документацию этого «долгосрочного» проекта.
Изучая проект документации ФОЛИО, я поговорил с Марсией Боренцтайн о потребностях ФОЛИО и текущей ситуации с документацией. Как упоминалось выше, документация ФОЛИО нуждается в обновлении, расширении и переработке, чтобы успешно помогать своим пользователям. Необходимо создать документацию, отражающую стандартные библиотечные процессы, а поскольку FOLIO состоит из различных «приложений», которые работают вместе, систему необходимо объяснить в целом. Поскольку я библиотекарь, я хорошо знаком с типами сценариев и рабочих процессов, с которыми, скорее всего, столкнутся пользователи FOLIO и с которыми им понадобится помощь. Марсия работает над созданием новой базы знаний документации, используя Markdown, Git и Hugo. В результате этого проекта будет создана новая документация по FOLIO, которая послужит основой для будущего.