Versions Compared

Key

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

...

Accomplishments this Term:

  • Documentation maintenanceRebuilding and documenting processes:

    • Clarified internal processes and record-keeping concerning documentation maintenance. Identified how new contributors are added to GitHub repository with appropriate permissions, and clarified the roles and responsibilities for subteam members.

    • Updated process documentation in Confluence to support GitHub maintenance workflows.

  • Documentation maintenance:

    • Ongoing GitHub repository maintenance: merged 10 pull requests and closed 3 issues.

    • Updated process documentation in Confluence to support GitHub maintenance workflows.

    • Entire subteam familiarized with GitHub maintenance processes through in-meeting demos and GitHub for Everyone class offered by Lyrasis.

  • Outreach and community engagement:

    • Promoted use of the Tech Docs with an Online Forum presentation. Presentation focused on relationships and how the technical documentation can support different types of users.

    • Met with User Documentation subteam (UAC) to discuss complementary nature of technical and user documentation.

...

  • Now that baseline documentation is on a more solid footing, move into soliciting feedback and assessing new technical documentation needs? Perhaps identify one or two areas to focus on (e.g., index/Solr)?

  • Evaluate arrangement and organization of documentation for usability?

  • Distribute tasks across subteam

  • Link audit?

  • Education/outreach to community on how to contribute to documentation (e.g., how to create issue or pull request)?

  • Review content in /architecture/backend for version information? (e.g., database.md page )

...