2022-2023 TechDocs Work Plan

Goals:

  1. Ongoing maintenance and promotion of Github tech-docs repository

  • Clarify internal processes and record-keeping concerning documentation maintenance:

    • Clarify access to tech-docs repository and how to add new contributors.

    • Identify who on sub-team should be responsible for reviewing and merging pull requests.

  • Review and merge pull requests.

  • Review issues and address as required.

  • Promote Tech Docs work and facilitate broad community knowledge by linking to relevant portions of documentation in listserv responses and other communications.

Ā Ā 

2. Identify gaps and areas of potential improvement in documentation

  • Review organization of content and identify areas requiring refinement.

  • Identify functionality with missing or insufficient documentation.

  • Review release notes of new releases for documentation needs.

  • Monitor listserv for issues for which further documentation would be helpful, and create stub/placeholders for documentation to be added

Ā 

3. Community engagement/outreach to solicit contributions to technical documentation

  • Identify more effective ways of soliciting feedback from users and developer community.

  • Solicit specific input/contributions from community (based on needs identified in #2).

  • Encourage ArchivesSpace community to submit issues regarding documentation directly to the tech-docs repository or contact sub-team members via email to suggest improvements.

  • Explore how to improve visibility of TechDocs and related resources to the wider community. Revisit prior terms' static site project for feasibility in coming term.

Ā 

4. Advisory Council Collaboration

  • Explore collaborative efforts between TechDocs and another body within the Advisory Council. Ideas include:

  • Identify training needs (e.g., skills, specific tools) that sub-team members need or would benefit from in order to be successful. Examples: Git, including technical training and best practices.

Themes

  1. Rebuilding

  2. Facilitate continuity between terms

  3. How can TechDocs support different types of users: beginners, turn users into super-users

  4. Information maintenance: Information Maintenance as a Practice of Care

Ā