Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Helpful Links:

https://archivesspace.atlassian.net/wiki/spaces/AC/pages/3358654478/2022-2023+TechDocs+Retrospective#Helpful-Links%3A

2023-2024 Techdocs Workplan

Themes Identified in Workplan:

  • Rebuilding

  • Regularity and Relevance

  • Information maintenance

  • Communication between Techdocs and developers

Accomplishments this Term:

  • Rebuilding and documenting processes:

    • Identified and established yearly audits of links and different documentation sites. These monthly audits will help ensure old documentation is reviewed yearly and appropriate changes made.

    • Establish an audit calendar and pull request calendar that aids in the distribution of work between group members.

  • Group restructure: communication between Techdocs and developers

    • There has been ongoing conversation on how to bridge the gap between Techdocs members, developers, and updating documentation. The group identified the main gaps and sparked the need to restructure what the TechDocs group does.

    • The group has been restructured to be an editorial role. The group will continue to provide reviews and send along any edits to the developers.

  • Information maintenance

    • Will now maintain and provide feedback on AwesomeArchivesSpace.

    • Continue to monitor Listservs and Github repositories.

  • Outreach and engagement:

    • Will provide editorial edits to other TAC/UAC groups that request a technical editorial role.

    • Redefined community engagement to also include groups presences on Listservs as a way to engage and spread awareness of TechDocs.

    • Worked closely with developers to begin conversations on establishing new workflows on how to seamlessly get edits/updates to developers to implement.

Areas for Potential Improvement:

  • Increase the monitoring of Aspace listservs.

  • Continue to identify regular editorial projects for the year.

  • Continue to navigate and flesh out the new structure/relationship with developers.

    • Creating documentation on the whole process.

  • Create an onboarding document that provides expectations, workflows, and yearly goals to members.

Priorities for 2024-2025 Term:

  • Establish a workflow to ensure all listservs are being properly and routinely monitored. This will help increase visibility of Techdocs group.

  • Improve/update the pull request workflows.

    • The pull request monitoring calendar is a great way to distribute work, however, there needs to be a more refined process in documenting the status and work done to each pull request. This will help with continuity of work for each pull request.

  • Improve onboarding for new group members.

  • With the restructuring of TechDocs, it is important to establish and document workflows as soon as possible to avoid potentially years of disjointed practices or policies. There is baseline documentation for many of the current workflows, these documents are merely in need of updates.

  • Identify and establish yearly trainings that aid in onboarding and ensure regular practices between terms.

    • Trainings such as Github, how to navigate AwesomeArchivesSpace, etc.

Leadership for 2024-2025 Term:

Lead: Bonnie Gordon

Vice Lead: TBD