Data Points

Good supporting documentation is critical for data, it should contain all important metadata and context to help an end user get full value from the data product they are using. Product documentation should contain some essential features.

 

• What the product name is
• Document and product version
• Detailed description of the product and it's variants
• How to get started with the product
• How to get product support
• File structures
• Data dictionary
• Glossary and acronym explanations
• Copyrights
• Appendices containing relevant supporting information
• An associated set of release notes with notable changes, fixes and know issues

 

The documentation should also be supported with a set of product statistics that include coverage and attribute fill rates.

------------------------------
Andy Bell
Director
Global Data Product Management
Pitney Bowes Software & Data
Leeds, UK
------------------------------

@Andrew Bell that's a great checklist for any Data Product - perhaps including a link to the appropriate Knowledge Community to encourage questions or suggestions about the product would further enhance the documentation.

I'm interested to hear thoughts from the greater Data Community about their wants/needs in Data product documentation.  Maybe you've seen some best practices or perhaps some things that are always weak?  I'm sure there are some other opinions out there!

------------------------------
Tom Gilligan
Pitney Bowes Software, Inc.
White River Junction, VT, USA
------------------------------

We will certainly add that link in.

Plus we should have links included to the SDM and for Map Explorer

------------------------------
Andy Bell
Director
Global Data Product Management
Pitney Bowes Software & Data
Leeds, UK
------------------------------

Original Message:
Sent: 09-03-2019 07:55
From: Tom Gilligan
Subject: What about the Product Documentation?

@Andrew Bell that's a great checklist for a Data Product. - perhaps in the "how to get product support" ideally we can also include links to the Knowledge Communities to encourage the end user raise questions or make suggestions about using the products so we can open a 2-way dialogue with the user.

------------------------------
Tom Gilligan
Pitney Bowes Software, Inc.
White River Junction, VT, USA
------------------------------

Other variations of self-serving support also include PB's Knowledge Base (a public facing knowledge article repository searchable by google) and Product Documentation Pages on our website.     FAQ's can always be beneficial within Product Documentation, on Product Documentation Web pages, or under any Get Support link within our Knowledge communities or the SDM , etc.        Do note that if all self-serving avenues are exhausted that we still do have a great team here to provide Tech Support on our Data Products ;-)

------------------------------
Chris Mabey
Director - AMER Tech Support
Pitney Bowes Software and Data Solutions
White River Jct., Vermont
------------------------------

Original Message:
Sent: 09-04-2019 03:56
From: Andrew Bell
Subject: What about the Product Documentation?

We will certainly add that link in.

Plus we should have links included to the SDM and for Map Explorer

------------------------------
Andy Bell
Director
Global Data Product Management
Pitney Bowes Software & Data
Leeds, UK
------------------------------


Original Message:
Sent: 09-03-2019 07:55
From: Tom Gilligan
Subject: What about the Product Documentation?

@Andrew Bell that's a great checklist for a Data Product. - perhaps in the "how to get product support" ideally we can also include links to the Knowledge Communities to encourage the end user raise questions or make suggestions about using the products so we can open a 2-way dialogue with the user.

------------------------------
Tom Gilligan
Pitney Bowes Software, Inc.
White River Junction, VT, USA