...
- Create and maintain documentation targeted to ONAP user audiences and the tasks they perform. For example:
- a platform developer pulling, building, running, hacking and pushing source code;
- an administrator installing, configuring, and monitoring an ONAP instance;
- a designer or tester creating, validating, and delivering service models;
- others as required for release plans or ONAP committees
- Establish and maintain a tool chain that supports the integration of documentation source material from all ONAP projects and builds documentation artifacts for each release.
- Establish documentation source material and final documentation dependencies in the release plan, end to end tests, and CI/CD to insure documents are available when needed in a release cycle and remain current with changes made in other software projects.
- Enable technical writer (contributors) for each release to create and integrate additional content based on overall release requirements.
- Benefits include:
- documentation is an integral part of the design and development of an ONAP release thus the software architecture, design models, etc. influence the language used to describe end to end platform to a user audience or vice versa the end to audiences and platform drive clarity of design.
- documentation is efficiently maintained with the software, created as part of the CI/CD process, and will be in sync with the software in a release.
- in a released version of ONAP, users quickly understand how to do required tasks
...