Documentation & Training

1. Issues

   1. Documentation & training materials are often not organized in such a way that they are easy to discover.

   2. Lack of documentation & training can be a barrier to entry.

   3. Documentation and training are often out of sync with

2. Questions

   1. Should documentation and training be viewed as discrete categories?

   2. What are the boundaries (definitions) for documentation and training?

3. Assumptions

   1. Those writing documentation and training materials are most often those who are in current need of the materials.

Documentation Only

1. Audiences

   1. Executives

   2. Non-Technical

   3. Techncial

2. Locations

   1. www.projecthydra.org

   2. wiki.duraspace.org

   3. www.github.com (per repo)

      1. pages

      2. wiki

      3. readme

      4. tests (& user stories)

      5. code comments

      6. self-documenting code

   4. hydra-community distribution list

   5. hydra-tech distribution list

3. Issues

   1. A high level overview of hydra projects, specifically solution bundles would be particularly useful.

   2. It seems to be the case that newer members of the community do not feel confident in editing the duraspace wiki.

   3. Documentation is often not organized in such a way that materials are easy to discover.

4. Questions

   1. Is it possible or feasible to create a best practice recommendation for incorporating documentation generation into the development workflow?

      1. This has been tried before. What can we learn from previous attempts? Is there something feasible that could be incorporated?

5. Assumptions

6. Recommendations

   1. Create a survey to capture the most significant pain points related to documentation issues.

   2. Write a feature matrix for hydra solution bundles.

Training Only

1. Audiences

   1. Executives

   2. Non-Technical

   3. Techncial

2. Locations

   1. Hydra Camp

   2. Hydra Connect

   3. www.github.com (per repo)

      1. pages

      2. wiki

3. Issues

   1. It seems to be the case that newer members of the community are hesitant to edit the wiki.

   2. It seems to be the case that training materials are often out of sync with the associated code.

4. Questions

   1. Is it possible or feasible to create a best practice recommendation for incorporating training materials into the development workflow?

      1. This has been tried before. What can we learn from previous attempts? Is there something feasible that could be incorporated?

   2. Is it the case that a larger sample project is needed as a training avenue for entry level hydra developers?

5. Recommendations

   1. Create a survey to capture the most significant pain points related to training issues.