2018-2019 Technical Documentation sub-team Work Plan
1. Formalize tech-docs repository as the official location of ArchivesSpace technical documentation
Ensure that build page is updated to pull in data from tech-docs repository
Maintain documentation in tech-docs repository
Coordinate with @Laney McGlohon (Unlicensed) to formalize this process
2. Communicate with ArchivesSpace constituencies to solicit input and share sub-team work
Encourage ArchivesSpace community to submit issues regarding documentation directly to the tech-docs repository or contact sub-team members via email to suggest improvements.
Coordinate sub-team work with Technical Advisory Council; seek input on documentation from TAC.
Seek additional input from developer constituency regarding documentation needs.
Promote Tech Docs work and facilitate broad community knowledge by linking to relevant portions of documentation in listserv responses and other communications.
3. Prioritize documentation changes based on community feedback
Monitor listserv for issues for which further documentation would be helpful, and create the appropriate documentation, or at least a stub for future documentation, in a timely fashion.
Review issues in tech-docs repository and address as required.
4. Update API documentation
Coordinate with Core Committers group regarding potential improvements in the way API documentation is stored and generated.
Improve ‘examples’ and ‘parameters’ sections, beginning with most problematic endpoints.
Integrate API documentation into tech-docs repository.