2020-2021 Technical Documentation Sub-team Work Plan

Owned by Trevor Thornton
Sept 09, 2020
1 min read

  1. Maintenance/promotion of Github tech-docs repository

    1. Review and merge pull requests

    2. Review issues and address as required

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

  2.  Facilitate decoupling of technical documentation from main application build process by building documentation site directly from Github tech-docs repository

    1. Technical QA (broken links, formatting, etc.)

    2. Explore strategies for static site generation and deployment (Jekyll, Netify, etc.)

  3. Identify gaps and areas of potential improvement in documentation

    1. Review organization of content and identify areas requiring refinement

    2. Identify functionality with missing or insufficient documentation

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

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

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

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

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