Copy of API Documentation working group Retrospective

What went wellWhat could have gone better
  • Early enthusiasm for the group; improving the API documentation is something that many involved in TAC and the broader community are interested in
  • Submitted a pull request to fix a bug that was causing numerous issues in the API documentation: https://github.com/archivesspace/archivesspace/pull/1201
  • The group had several false starts and never really got off the ground in the way that participants wanted
  • Finding participants early on proved difficult; those that did get involved were involved in several other TAC teams which could have contributed to lack of ability to devote time to the API documentation working group
  • The group would have benefited from having more participants from the broader community or the ArchivesSpace development team
  • The scope of the group could have been clearer/narrower, which may have included: focus only on several specific endpoints and improve the documentation for those, make additional improvements to the automated Slate documentation code, add a new sub-page to the technical documentation giving example requests and expected responses