Topics, Notes, and Follow-Up Tasks

TopicNotesFollow-up
Goals / M1 Deliverables

Mission:  “Create and maintain documentation targeted to ONAP user audiences and the tasks they perform.”
Key measures of success:

  • Comprehensive – covers all in-scope topics & projects
  • Accurate – edited for consistency and correctness
  • Timely – lines up with new releases

Scope and Roles:

  • Focus is on Technical topics and projects, Project Mgt and Community topics are out of scope at least initially
  • Project teams have primary responsibility for documentation, including any new/updated source code
  • Documentation team primarily provides editing, validation and oversight; authoring / requesting new documentation only as needed 

Team Functions:

  • Insure appropriate documentation exists for all in-scope topics and projects; insure updates are submitted for each new release
  • Edit submissions for consistency and correctness:  Alignment with the ONAP style guide; Appropriate level of detail for intended audience(s)
  • Insure new / updated documentation is edited, validated and published in synch with each release

Tool Chain ExamplesDraft Comparison and Recommendation of Document Tool Chain
Next Steps
  • Regroup current Wiki Topics into simpler structure based on Audiences / Roles (e.g. Developer, User, Operations, etc.) Gregory Glover 
  • Schedule special meeting with project team members on June 29 from 7-8 pm ET to review 1) draft structure and 2) Tool chain options Kenny Paul 
  • Clarify what documentation needs to be formally captured and managed vs. use of the Wiki Gregory Glover  
  • Draft what it means to Validate content Gregory Glover  
  • Identify a formal Documentation contact for each Project Gregory Glover 
  • Create initial draft for M1 Deliverables Rich Bennett