Usability

Level Definitions

• Level 1:

•  

  • User guide created

  • Deployment documentation

  • API documentation

  • Adherence to coding guidelines

• Level 2:

•  

  • API Documentation

    • All new API’s must adhere to the ONAP API Common Versioning Strategy and Documentation Guidelines

    • All existing APIs must be documented in Swagger 2.0

• Level 3

•  

  • Consistent UI across ONAP projects

  • Usability testing conducted

  • API Documentation

    • All new API’s, all external APIs, and all existing API’s that are modified must adhere to the ONAP API Common Versioning Strategy and Documentation Guidelines

• Level 4

•  

  • API Documentation

    • All API’s for a given project must adhere to the ONAP API Common Versioning Strategy and Documentation Guidelines

Minimum Levels

• All Projects: Level 2

• Stretch Goal: External APIs also follow the Versioning Strategy

Guidance for Implementation

• This presentation gives a good review of what types of documentation should be done and when in the release lifecycle.

• Please see the Documentation team for more information.

Contacts

Documentation team