...
- How does this project fit into the rest of the ONAP Architecture?
A parallel thread to create documentation artifacts with dependencies on the capabilities, configuration, and interfaces provided by software projects as illustrated below.
- Dependencies on all projects providing source material for documentation.
- Code changes may drive documentation changes.
- Some documentation e.g. VNF Requirements may need to be traceable to code modules (e.g. test cases)
- Target use cases drive the user audience and task requirements for a release.
- Dependencies on all projects providing source material for documentation.
- How does this align with external standards/specifications?
- Project will identify best practices for a documentation tool chain by looking at other open source projects (eg. open daylight, opnfv)
- Are there dependencies with other open source projects?
- Evaluate use of readthedocs.org as way of publishing documents.
- Evaluate the use of swagger.io for API documentation
...