2024-2025 Techdocs Work Plan

Owned by Bonnie Gordon
Last updated: Sept 11, 2024
1 min read

Goals

  • Maintain ArchivesSpace technical documentation in tech-docs Github repository

  • Solicit feedback and contributions from the community

  • Perform outreach and make ArchivesSpace community aware of TechDocs

Specific Tasks or Projects

Ongoing/Recurring Tasks

  • Review and merge community pull requests in tech-docs repository.

  • Review pull requests and issues in Awesome ArchivesSpace repository and add new resources.

  • Monitor listserv, linking to relevant portions of documentation in listserv responses or encouraging the community to submit GitHub issues regarding documentation.

  • For minor ArchivesSpace releases, review release notes and provide edits/suggested changes to developers.

New Projects for This Term

  • Review API documentation to identify where further clarity is needed and where examples could be improved.

  • Identify ways to encourage community to use and update tech-docs, including by surfacing GitHub repository and exploring using Jira to manage issues.

  • Facilitate updates to tech-docs that are part of the next major release, including reviewing release notes and working with Lyrasis developers to approve and merge pull requests.

  • Present on sub-team’s activities at virtual member forum. (Spring 2025)

  • Explore possible usability improvements to tech-docs site, including adding a table of contents to each page.