TALK | How we created an automated workflow to generate our documentation in minutes

1. Improving Documentation Workflow to Increase Efficiency
With Postman

2. ● In business since 2009, located in Knoxville, TN.
● Personnel has been involved with statistical data since late 90's.
● Focus on delivering solutions around government data, official statistics, and
research data in proficient and cost effective ways.
● Aim to ensure that data is always surrounded by all the necessary knowledge (or
"metadata") to support its effective use, maximize quality, facilitate discovery, and
provide policy makers, users, and the general public with knowledge needed for
sound policy making, research, and information.

3. ● Released to the public March 6, 2020.
● RDS Consumer (API)
○ Concurrent access to data and metadata over Industry standard REST service
○ For data scientists / researchers, developers (applications); self-service;
○ Services: /catalog (metadata), /query (select, tabulate), /package (open), stats (usage)
● RDS - Explorer (UI)
○ Browse record level data, access data dictionary / metadata, create data subsets (variables, filters),
open data packaging (extract / download)
● RDS - TabEngine (UI)
○ Aggregate data tables, download in CSV / Excel, (graphs / maps)
● COVID-19 data center available at covid19.richdataservices.com

8. Let's take a look at our COVID-19 Resource Center documentation...

9. Update the Rich Data
Services catalog
Generate the Postman
collection
Generate the
example responses
with Newman
Publish / Update the
collection through the
Postman API
1 2
3 4

10. ● RDS COVID-19 Data Center - https://covid19.richdataservices.com
● RDS Public Data Center - https://public.richdataservices.com
● Postman Collection JSON Schema -
https://schema.getpostman.com/json/collection/v2.1.0/collection.json
● Maven Plugin - jsonschema2pojo-maven-plugin -
https://github.com/joelittlejohn/jsonschema2pojo
● Postman Collection Java Model -
https://github.com/mtna/postman-utils/tree/master/postman-model
● Newman Example Generator -
https://github.com/mtna/postman-utils/tree/master/newman-example-generator
● Postman API Documentation -
https://documenter.getpostman.com/view/631643/JsLs/?_ga=2.224601818.1147689307.16026
07916-1810067278.1593016766#aa3701e8-7f99-b421-7d74-0d571b051f3c