Versions Compared

Key

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

...

2022-2023 TechDocs Work Plan

Themes Identified in Workplan:

  • Rebuilding

  • Continuity between terms

  • Support for different types of users

  • Information maintenance

Accomplishments this Term:

...

  • 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., individuals frequently ask about the index/Solr on listservs) in order to keep scope achievable.

  • Continue to clarify subteam roles to determine how TAC can best support the program developers and how new subteam members can best contribute.

  • Brainstorm for next term’s themes, priorities, and priorities:projects:

    • Evaluate holistic arrangement and organization of documentation for usability

    • Distribute tasks across subteam; identify tasks that subteam members can complete during their first term

    • Link audit to identify and correct broken links – this seems like an activity that could be delegated across the subteam, including to new members. This could also provide an relatively low barrier of entry in learning how to create pull requests.

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

    • Review content in /architecture/backend and other areas for helpful information that corresponds with much earlier versions (e.g., database.md page has so much good information that would be helpful to many in the community, but it is current with 2.7.1).

    • Inquire if it is possible to create or generate entity-relationship diagrams for each version

    • Review content of documentation for overall ease of use with a focus on technical writing concepts like clarity, simple sentences, and concise language.

...