2019-01-17 Meeting Notes

Focus in on getting full V1 documentation complete an PMC agreed at last week's meeting that this should be the core focus across all WGs until complete.

To main points reviewed/discussed:

• current github Readme
  • has become very technical
  • there was a less tech one that got been replaced and should to be re-instated. ACTION: Nick to re-instate via a PR.
  • Riko to talk to Mao on standard template for ReadME pages to ensure consistency across the site
• documentation site
  • This group needs to agree content for the API portion of the FDC3 microsite
  • This will autogenerated from the GitHub repo
  • The general readme should become the landing page
  • Release info should be in release build and added to general info

Riko noted that he and Espen and Mao are working on the strawman and that they will focus on overall look and feel and how the site hangs together. Rob confirmed that FINOS can help where needed.

Leslie asked about guidance on documentation of demo versions of FDC3 and how this should be linked and any requirements regarding disclosing commercial (or non-commercial) operations. This should be added to the PMC agenda.

Content gaps identified:

• Clearly describe what you do with this API, for a developer, product manager, etc.
• Include a schematic that shows how it all comes together
• Should every API call have a code example?
• Potentially provide a comprehensive example that ties back to use cases and incorporates context and intents. Would be good to talk to Use Cases group to figure out how/which use case to use to highlight the business value
• Diagrams/schemas should be consistent across the board. FINOS can help with this and other design elements.

Actions

• Nick to reinstate the summary in the Readme
• Riko to talk to Mao about the standard Readme template
• Need a "full picture guide" - for the PMC
• Unify look and feel of technical diagrams in specs - FINOS can evaluate restyling.  Espen to aggregate diagrams for Rob, Tosha.
• Identify relevant use cases examples