Documentation & Training Effort
Bill Branan
Documentation & Training
- Issues
- Documentation & training materials are often not organized in such a way that they are easy to discover.
- Lack of documentation & training can be a barrier to entry.
- Documentation and training are often out of sync with
- Questions
- Should documentation and training be viewed as discrete categories?
- What are the boundaries (definitions) for documentation and training?
- Assumptions
- Those writing documentation and training materials are most often those who are in current need of the materials.
Documentation Only
- Audiences
- Executives
- Non-Technical
- Techncial
- Locations
- www.projecthydra.org
- wiki.duraspace.org
- www.github.com (per repo)
- pages
- wiki
- readme
- tests (& user stories)
- code comments
- self-documenting code
- hydra-community distribution list
- hydra-tech distribution list
- Issues
- A high level overview of hydra projects, specifically solution bundles would be particularly useful.
- It seems to be the case that newer members of the community do not feel confident in editing the duraspace wiki.
- Documentation is often not organized in such a way that materials are easy to discover.
- Questions
- Is it possible or feasible to create a best practice recommendation for incorporating documentation generation into the development workflow?
- This has been tried before. What can we learn from previous attempts? Is there something feasible that could be incorporated?
- Assumptions
- Recommendations
- Create a survey to capture the most significant pain points related to documentation issues.
- Write a feature matrix for hydra solution bundles.
Training Only
- Audiences
- Executives
- Non-Technical
- Techncial
- Locations
- Hydra Camp
- Hydra Connect
- www.github.com (per repo)
- pages
- wiki
- Issues
- It seems to be the case that newer members of the community are hesitant to edit the wiki.
- It seems to be the case that training materials are often out of sync with the associated code.
- Questions
- Is it possible or feasible to create a best practice recommendation for incorporating training materials into the development workflow?
- This has been tried before. What can we learn from previous attempts? Is there something feasible that could be incorporated?
- Is it the case that a larger sample project is needed as a training avenue for entry level hydra developers?
- Recommendations
- Create a survey to capture the most significant pain points related to training issues.
{"serverDuration": 16, "requestCorrelationId": "f7ca8cf5c03c4258975ec41caa95eee4"}