...
As a community building an open source library services platform, the FOLIO community is inviting experienced technical writers to explore working with us to enhance our current documentation. Below are the project ideas under consideration. We are happy to discuss adjustments to the projects based on the writer’s background and interests.
About our 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.
The FOLIO platform integrates the management of print and electronic resources; it includes functionality to manage the circulation of print materials, their cataloging and acquisitions, as well functionality to manage electronic resources including the library’s e-journal subscriptions or e-books. Yet FOLIO goes beyond ‘traditional’ library functionality. In order to drive continuous innovation, the platform leverages a microservices architecture. Rather than comprising a single, monolithic system, FOLIO supports smaller apps, so libraries can enjoy easier updates and benefit from faster development. Libraries can work on these apps independently or work with different vendors and different teams who may contribute and develop apps in their areas of expertise. The FOLIO APIs are thereby open, so the platform can integrate more easily with existing campus and library systems – providing libraries more choice for services today and in the future.
FOLIO is an open source project under the Open Library Foundation, a non-profit organization dedicated to open source in libraries. The FOLIO roadmap, requirements, discussions and code are all public. Community resources include:
- folio.org
- wiki.folio.org
- github.com/folio-org
- docs.folio.org
- dev.folio.org
- issues.folio.org
- discuss.folio.org
Project Ideas
Project idea: Translation of FOLIO documentation on docs.folio.org
Problem
- Currently, our documentation is produced only in English. FOLIO is in use by libraries worldwide, and we expect our documentation to be available in multiple languages. We are looking for someone who has had experience in documentation translation and can help ensure that any changes made in the English documentation are reflected in the translated versions.
How would we measure success
- There will be documentation available in one more languages besides English.
- There will be technologies and processes in place to ensure changes in the English content are reflected in the non-English content.
What skills would a technical writer need to work on this project?
- Must have: Experience in translation/localization of documentation
- Nice to have: Ability to work with subject matter experts across the globe
- Nice to have: Knowledge of the library industry
Project idea: Add graphics to docs.folio.org
Problem
- Our current documentation is text-heavy, and could be improved with the addition of graphics or short videos. The graphics should be consistent and use the appropriate colors and branding. To that end, some current graphics can be re-created to better align with FOLIO branding guidelines.
How would we measure success
- Add at least one graphic or video to each of the apps documented in docs.folio.org.
- There will be consistency among the graphics/videos.
- There will be a clear standard regarding the creation and maintenance of graphics/videos.
What skills would a technical writer need to work on this project?
- Must have: Graphic design
- Nice to have: Video creation
- Nice to have: Instructional design
- Nice to have: Ability to work with subject matter experts across the globe
- Nice to have: Knowledge of the library industry
Project idea: Improve search on docs.folio.org
Problem
- Our current search engine does not always produce the most relevant results. We would like to review how we can improve the search functionality, for example, by implementing a new search engine.
How would we measure success
- Subject matter experts in the community positively evaluate search results.
What skills would a technical writer need to work on this project?
- Must have: Knowledge of different search engines, and which could be integrated into our site
- Nice to have: Knowledge of the library industry
For more information about
...
FOLIO documentation projects, please contact marcia1.folio@gmail.com.