2017-06-27 Doc Project Meeting

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 Examples

Draft Comparison and Recommendation of Document Tool Chain

Next Steps