Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.
Resumo do projeto
- Organização de código aberto:
- FOLIO
- Redator técnico:
- gallinita
- Nome do projeto:
- Expansão da documentação do usuário final para apps FOLIO
- Duração do projeto:
- De longa duração (5 meses)
Project description
Para este projeto, pretendo trabalhar na criação e atualização da documentação do FOLIO voltada ao usuário final. Como o FOLIO é um sistema de gerenciamento de bibliotecas, o usuário final é a equipe da biblioteca. Atualmente, a wiki do FOLIO (https://wiki.folio.org/) contém alguma documentação, mas ela é mínima e não está em um formato fácil de entender, criado para a equipe da biblioteca. A nova documentação criada com base neste projeto será hospedada em uma base de conhecimento específica, que pode ser acessada pelos apps do FOLIO, e vai conter fluxos de trabalho relevantes para os usuários do sistema e das bibliotecas dele. Um conjunto inicial de documentação será publicado no site, começando com a circulação e a funcionalidade de reservas do curso. Gostaria de contribuir o máximo possível para a documentação ao longo deste projeto de “longo prazo”.
Ao analisar o projeto de documentação do FOLIO, conversei com Marcia Borensztajn sobre as necessidades do FOLIO e a situação atual da documentação. Como mencionado acima, a documentação do FOLIO precisa ser atualizada, expandida e reformulada para ajudar os usuários. A documentação precisa ser criada para espelhar os processos padrão da biblioteca e, como o FOLIO é composto por diferentes "apps" que funcionam juntos, o sistema precisa ser explicado como um todo. Como bibliotecário, conheço bem os tipos de cenários e fluxos de trabalho que os usuários do FOLIO provavelmente vão enfrentar e precisam de ajuda. Marcia está trabalhando na criação de uma nova base de conhecimento de documentação usando Markdown, Git e Hugo. A partir desse projeto, uma nova documentação sobre o FOLIO será criada e servirá como uma estrutura para o futuro.