Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.
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 dos apps FOLIO
- Duração do projeto:
- De longa duração (5 meses)
Project description
Para este projeto, pretendo criar e atualizar a documentação do FOLIO voltada para o usuário final. Como o FOLIO é um sistema de gerenciamento de bibliotecas, o usuário final é o pessoal da biblioteca. Atualmente, o 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 digerir, criado pensando no pessoal da biblioteca. A nova documentação criada com base neste projeto será hospedada em uma base de conhecimento específica, que poderá ser acessada pelos apps do FOLIO e conterá fluxos de trabalho relevantes para o sistema e os usuários da biblioteca. Um conjunto inicial de documentação será publicado no site, começando pela funcionalidade de circulação e reservas de curso. Eu gostaria de contribuir o máximo possível com a documentação ao longo deste projeto de "longa duração".
Ao analisar o projeto de documentação do FOLIO, conversei com Márcia 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, ampliada e retrabalhada para ajudar os usuários. A documentação precisa ser criada para espelhar os processos padrão da biblioteca. Como o FOLIO consiste em diferentes "apps" que funcionam juntos, o sistema precisa ser explicado como um todo. Como sou bibliotecária, conheço bem os tipos de cenários e fluxos de trabalho que os usuários do FOLIO provavelmente vão enfrentar e com os quais precisam de ajuda. Marcia está criando a nova base de conhecimento da documentação usando Markdown, Git e Hugo. Com esse projeto, uma nova documentação sobre o FOLIO será criada e servirá como um modelo para o futuro.