...
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.
Project Proposal: Translate documentation on docs.folio.org
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.
...
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
About the project
Project 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 establish how we manage the translation process. As part of the process, we also want to ensure that any changes that are made in the English language content are reflected in the translated versions.
Project scope
In scope
We expect this project to:
- Help establish the technologies and procedures needed for translation
- Produce an initial set of translated documents
Out of scope
FOLIO has extensive English language documentation. We do not expect that this project produce all the documentation for all the languages we eventually want to support. Rather, we are interested in establishing a solid foundation on which to build our non-English language materials.
Project success
We will consider the project a success if:
- There will be documentation available in at least one more language besides English.
- Technologies are evaluated and selected for use in the translation process.
- There will be a clear standard regarding processes for the creation and maintenance of non-English content.
Project timeline
| Dates | Action Items |
|---|---|
| May | Orientation |
| June | Assessment of needs |
| July - August | Recommendation of technology and methodology |
| September - November | Implementation of technology and first translations available |
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 | |
| Writer appreciation stipends | 250.00 | 6250.00 | Thank you gift upon successful completion of the project. |
| TOTAL | 6250.00 |
Additional Information
Previous experience with technical writers or documentation:
As a technical writer/editor with over twenty-five years of experience, I have managed global teams of writers and mentored writers of varying degrees of experience. In the context of the Season of Docs program, I both reviewed the writers’ content myself and facilitated the connection between the writers and the appropriate subject matter experts. They conducted their reviews both via Zoom and via shared Google docs. Each of the writers brought a wealth of skills to bear on our project. Each was able to work effectively and efficiently with the relevant subject matter experts to clarify needs and resolve any open questions as they arose.
Previous participation in Season of Docs, Google Summer of Code or others:
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.
...
Project Ideas
The following ideas were considered as candidates for FOLIO documentation projects.
Project idea: Translation of FOLIO documentation on docs.folio.org
...