Project Proposal: Update FOLIO End User and System Administrator Guides
About your organization
FOLIO is a community project for and by librarians and vendors alike to develop the FOLIO open source library management system or library services platform (LSP). FOLIO is an entirely new platform, designed by academic librarians, and written from the ground up as the first new LSP in 10 years. FOLIO seeks to provide libraries with more choice in how to develop, deploy and manage library software.
...
- folio.org
- wiki.folio.org
- github.com/folio-org
- docs.folio.org
- dev.folio.org
- issues.folio.org
- discuss.folio.org
About the project
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.
...
Ultimately, this documentation project is an important piece to support product adoption and general use.
Project scope
The Update FOLIO End User and System Administrator Guides project will:
- Create content for the apps that have no documentation available on docs.folio.org.
- Maintain the Resource Access content that was recently 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 published.
We have are currently looking for two strong technical writers for this project, each of whom has successfully worked with the FOLIO organization and the Google Season of Docs program (2020 season). 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.
Measuring project sucess
We would consider the project successful if, after publication of the new documentation:
- There will be published content available for each of the FOLIO apps.
- The current documentation will be updated with changes based on the next releases.
- There will be published content available to support system administrators.
Project budget
| Budget Item | Amount | Running Total | Notes/Justifications |
|---|---|---|---|
| Technical writer update and expansion of non-technical content, including review with SMEs, conversion to markdown, and publication to GitHub and the Hugo-based website. | 6000.00 | 6000.00 | |
Technical writer update and expansion of technical installation and system administrator content, including review with SMEs, conversion to markdown, and publication to GitHub and the Hugo-based website. | 6000.00 | 12000.00 | |
| Volunteer stipend | 250.00 | 12250.00 | |
| Writer appreciation stipends | 500.00 | 12750.00 | Thank you gift upon successful completion of the project at 250 each |
| TOTAL | 12750.00 |
Technical Writer Qualifications
We are looking for experienced technical writers with the ability to:
- Communicate complex ideas in writing in a simple, accessible way for a global audience
- Understand end user needs and build content accordingly
- Create content that meets established editorial standards
- Collaborate with subject matter experts across the globe
Nice to have:
- Background in library systems
- Knowledge of markdown language
- Familiarity with GitHub
- Graphic design skills
Interested technical writers should email samples of work to marcia1.folio@gmail.com.
Additional information
Previous experience with technical writers or documentation:
...
-----------------------------------
Project Ideas
After successful completion of the 2020 and 2021 Google’s Season of Docs initiative, the FOLIO community plans to participate in the 2021 2022 program. The Google Season of Docs program is an effort to bring technical writers and open source projects together to foster collaboration and improve documentation in the open source space. During the program, technical writers work closely with an open source community. They bring their technical writing expertise to the project’s documentation and learn about the open source project and new technologies.
...