...
The FOLIO project needs to expand its supporting documentation for use by multiple types of librarians and system administrators. Different librarians support different areas of library functions and each needs up-to-date information about how the FOLIO apps work in order to perform their day-to-day job functions. The site docs.folio.org is relatively new, and needs significant additional work in order to be a complete resource for users. Currently, some apps have been documented and others have not. The first goal is to create a first version of documentation for each app. As each first version for each app is created, we immediately need to shift to maintenance of that content so as not to fall out-of-date.
...
- Create content for the apps that have no documentation available on docs.folio.org.
- Maintain the Resource Access content that was recently has already been published.
- Review the needs of system administrators to identify the most important content to develop.
- Develop the highest priority system administration documentation.
- Maintain the Installation content that was recently has already been published.
We are currently looking for two technical writers for this project. See Technical Writer Qualifications below for more information. We estimate that the work will take six months to complete. The writers will be supported by multiple SIGs, who have committed to making subject matter experts available. The writers will also be supported by the FOLIO Technical Writing Editor, Marcia Borensztajn.
...
FOLIO first participated in Google Season of Docs in 2020 and continued on to participate in the 2021 season as well. We originally worked with two technical writers, each of whom contributed significantly to the documentation effort. On the more technical side, one writer worked to create documentation of the installation process. This content is of significant use both to institutions who are considering moving to our open source library platform, as well as to those who are already pursuing implementation. Our other writer focused on librarians using the FOLIO platform in their day-to-day roles as librarians. With this content developed, the project is now able to better support end users as they perform their job-related tasks.
-----------------------------------
...
Problem
- Currently, there are many some FOLIO apps that are not documented on docs.folio.org. Our end users and community need documentation of all FOLIO apps in order to use the software effectively. We also need to update the information to keep pace with the next releases of the software. In addition, system administrators need more documentation to help manage the system.
...