After successful completion of the 2020 Google’s Season of Docs initiative, the FOLIO community plans to participate in the 2021 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.
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 idea: Update FOLIO End User and System Administrator Guide
Problem
- Currently, there are many 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.
How would we measure success
- 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.
What skills would a technical writer need to work on this project?
- Ability to work with subject matter experts across the globe
- Ability to help define areas of priority
- Knowledge of library systems technical platforms
- Knowledge of the library industry
Project idea: Add graphics to the FOLIO End User and System Administrator Guide
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.
- Consistency among the graphics/videos.
What skills would a technical writer need to work on this project?
- Graphic design
- Video creation
- Instructional design
- Ability to work with subject matter experts across the globe
- Knowledge of the library industry
For more information about either of the FOLIO documentation projects, please contact marcia1.folio@gmail.com.