Best Practices

From Share-PSI EC Project
Jump to: navigation, search

This is the original page where BP stories and Atomic BPs have been collected.

See the results of the survey in File:Share-PSI Best Practice Evaluation.xls

 This page is now superseded by BP_2


This page lists links to specific best practices. They are also shown as Word Clouds and there is a starter OWL file to be used for card-sorting.(catalog-v001.xml included for protege ) In addition there is some very experimental document clustering work.

Distribution of BPs by PSI Element

The lists below are based on the spreadsheet prepared initially by Makx File:BPs-vs-PSI Directive.xlsx. Please see the implementation report for status of the proposed BPs and evidence.

Policies and Legislation

Covering topics like:

  • Legal requirements
  • licenses etc.
  • licensing of information, data and metadata)

Primary responsibility: Nancy

Stories

  1. Best Practices/Cross Agency Strategy
  2. Best Practices/Open Data Publication Plan
  3. Best Practices/High Level Support
  4. Best Practices/Holistic Metrics
  5. Best Practices/Encourage crowdsourcing
  6. Best Practices/Management Of A Wide Public Actors Network
  7. Best Practices/Making Research Results Open For The Country
  8. Best Practices/Publishing Statistical Data In Linked Data Format
  9. Best Practices/A Federation Tool For Opendata Portals (Consider linking to DCAT-AP)
  10. Best Practices/Getting Journalists Involved In the Process Of Opening Up Data
  11. Best Practices/Opening Up Public Transport Information to Save Costs
  12. Best Practices/Commercial Considerations in Open Data Portal Design
  13. Best Practices/Infomediary Sector Characteristics
  14. Best Practices/Free our maps
  15. Best Practices/Open Data Startups Accelerator
  16. Best Practices/Encouragement via bonuses
  17. Best Practices/The Central Role of Location
Indented line

Atomic BPs

External BPs

None from W3C as this is a non-tech topic

Platforms

Covering:

  • Open data platform(s)
  • publication and deployment of information
  • data and metadata

Primary responsibility: Fatemeh

Stories

  1. Best Practices/Human Readability and Machine Processing
  2. Best Practices/Catalogs and Indexes
  3. Best Practices/Encourage crowdsourcing
  4. Best Practices/Management Of A Wide Public Actors Network
  5. Best Practices/Publishing Statistical Data In Linked Data Format
  6. Best Practices/Civic Use Of Open Data
  7. Best Practices/A Federation Tool For Opendata Portals
  8. Best Practices/Traffic Light System For Data Sharing
  9. Best Practices/Getting Journalists Involved In the Process Of Opening Up Data
  10. Best Practices/Opening Up Public Transport Information to Save Costs
  11. Best Practices/A Federation Tool For Opendata Portals (Consider linking to DCAT-AP)
  12. Best Practices/Commercial Considerations in Open Data Portal Design
  13. Best_Practices/The_Central_Role_of_Location
  14. Best Practices/An ongoing open dialog in an open data ecosystem
  15. Best Practices/Open Data by Open Software in Szeged
  16. Best Practices/Open Data Startups Accelerator
  17. Best Practices/OpenMove - open platform for mobile ticketing
  18. Best Practices/Make the data available in the language people want it

Atomic BPs

External BPs

The Metadata section of the DWBP doc is likely to be useful

Dataset criteria

Covering:

  • Dataset criteria
  • priorities
  • value and scope

Primary responsibility: Emma

Stories

  1. Nicolas Loozen's talk in Timisoara was very relevant to this. paper & slides [Best_practice/dataset_criteria]
  2. Best Practices/User engagement and collaboration throughout the lifecycle
  3. Best Practices/Stakeholders’ Interests and Rights [not convinced this is relevant to dataset criteria]
  4. Best Practices/Catalogs and Indexes [not convinced this is substantial enough to include as a best practice]
  5. Best Practices/Encourage crowdsourcing [1]
  6. Best Practices/Management Of A Wide Public Actors Network [this is an example of implementing a national network for open data, rather than a best practice for dataset criteria]
  7. Best Practices/Making Research Results Open For The Country
  8. Best Practices/Open Data Publication Plan
  9. Best Practices/Traffic Light System For Data Sharing
  10. Best Practices/Open Data To Improve Sharing And Publication Of Information Between Public Administrations
  11. Best Practices/Infomediary Sector Characteristics [this is not directly relevant to dataset criteria]
  12. Best Practices/Open Data 2.0 - Changing Perspectives
  13. Best Practices/Free our maps [better in policy?]
  14. Best_Practices/The_Central_Role_of_Location [not relevant to dataset criteria]
  15. Best Practices/Raising awareness and engaging citizens in re-using PSI [not relevant to dataset criteria]

Atomic BPs

External BPs

See the Sensitive data and feedback sections of the DWBP doc. Note also the Dataset Usage Vocabulary.

Charging

Covering:

  • Charging issues and proposals

Primary responsibility:' Makx

Stories

  1. Best Practices/A Federation Tool For Opendata Portals
  2. Best Practices/Infomediary Sector Characteristics
  3. Best Practices/Cost of Publication
  4. Best Practices/DigMap- digital map excerpt

Atomic BPs

None of the Best Practices listed cover the topic of charging for data by the Public Sector. Some raise the issue that it is hard for the Public Sector to determine what data has commercial potential, but all of them pre-suppose that the data is made available openly and for free. Nevertheless, I tried to derive a general Best Practice from various stories:

  1. Best Practices/Provide PSI at zero charge (no consensus yet - seen as too political)

External BPs

Not really in scope for W3C. TOG??

Techniques

Covering:

  • Techniques for opening data, technical requirements and tools.

Primary responsibility: Valentina

Stories

  1. Best Practices/Human Readability and Machine Processing
  2. Best Practices/Cost of Publication
  3. Best Practices/Management Of A Wide Public Actors Network
  4. Best Practices/Publishing Statistical Data In Linked Data Format
  5. Best Practices/A Federation Tool For Opendata Portals
  6. Best Practices/Traffic Light System For Data Sharing
  7. Best Practices/Open Data Business Model Patterns and Open Data Business Value Disciplines
  8. Best_Practices/The_Central_Role_of_Location
  9. Best Practices/Discover published information by site scraping
  10. Best Practices/DigMap- digital map excerpt
  11. Best Practices/Open Data Bulk Download ----the same as the W3C BP Provide bulk download
  12. Best Practices/OpenMove - open platform for mobile ticketing
  13. Best Practices/References to spatial entities

Atomic BPs

External BPs

A lot of the DWBP doc should be relevant here so it's really a question of matching BPs in that doc to what the stores say. An obvious one to highlight is the Bulk download BP. The Context section has a handy diagram followed shortly afterwards by the current list of the actual BPs.

Organisation

Covering:

  • How to organise PSI sharing
  • Necessary functions and communications

Primary responsibility: Noel

Stories

  1. Best Practices/Cross Agency Strategy
  2. Best Practices/Organisational-internal engagement
  3. Best Practices/Cost of Publication- =cost
  4. Best Practices/Identifying what you already publish - =Techniques
  5. Best Practices/Making Research Results Open For The Country
  6. Best Practices/Using Business Process Paradigm For Open Data Lifecycle Management - = Quality
  7. Best Practices/Open Data To Improve Sharing And Publication Of Information Between Public Administrations
  8. Best Practices/Getting Journalists Involved In the Process Of Opening Up Data
  9. Best Practices/Infomediary Sector Characteristics
  10. Best Practices/Commercial Considerations in Open Data Portal Design - = Portal
  11. Best Practices/Open Data 2.0 - Changing Perspectives - =Charging
  12. Best Practices/Open Data Business Model Patterns and Open Data Business Value Disciplines - = Re-Use
  13. Best Practices/An ongoing open dialog in an open data ecosystem
  14. Best Practices/Discover published information by site scraping - = Techniques
  15. Best Practices/Open Data Startups Accelerator - = Re-Use
  16. Best Practices/Encouragement via bonuses - = Policies and Legislation
  17. Best Practices/Open Data Monitoring and Benchmarking - = Quality
  18. Best Practices/Stakeholders’ Interests and Rights - = Policies and Legislation
  19. Best Practices/Management Of A Wide Public Actors Network
  20. Best Practices/Boosting citizens’ awareness through the reuse of existing resources - = Platforms
  21. Best Practices/Bottom-up organisation
  22. Best_Practices/The_Central_Role_of_Location - = Discoverability

Atomic BPs

External BPs

Pretty much out of scope for W3C. Maybe others?

Formats

Covering:

  • Dataset structures
  • formats
  • APIs

Primary responsibility: Valentina

Stories

  1. Best Practices/Human Readability and Machine Processing
  2. Best Practices/Publish spatial data on the web
  3. Best Practices/Management Of A Wide Public Actors Network
  4. Best Practices/Publishing Statistical Data In Linked Data Format
  5. Best Practices/Supervizor - An Indispensable Open Government Application (Transparency Of Public Spending)
  6. Best Practices/A Federation Tool For Opendata Portals
  7. Best Practices/Traffic Light System For Data Sharing
  8. Best Practices/Open Data To Improve Sharing And Publication Of Information Between Public Administrations
  9. Best Practices/Opening Up Public Transport Information to Save Costs
  10. Best_Practices/The_Central_Role_of_Location
  11. Best Practices/Open Data by Open Software in Szeged
  12. Best Practices/DigMap- digital map excerpt

Atomic BPs

External BPs

  1. Data Formats
    1. Use machine-readable standardized data formats
    2. Use non-proprietary data formats
    3. Provide data in multiple formats
  2. Data Access
    1. Provide bulk download
    2. Follow REST principles when designing APIs
    3. Provide real-time access
    4. Provide data up to date
    5. Maintain separate versions for a data API

Re-use

Covering:

  • Encouraging (commercial) re-use

Primary responsibility: Martin

Stories

Atomic BPs

External BPs

Pretty much out of scope for W3C

Persistence

Covering:

  • Persistence of data and metadata
  • Maintenance and metadata

Primary responsibility: Peter

Stories

  1. Best Practices/Using Business Process Paradigm For Open Data Lifecycle Management
  2. Best Practices/A Federation Tool For Opendata Portals
  3. Best Practices/Open Data 2.0 - Changing Perspectives
  4. Best Practices/References to spatial entities

Atomic BPs

To do

External BPs

  1. Data Identification
    1. Use persistent URIs as identifiers
    2. Assign URIs to dataset versions and series

Quality

Covering:

  • Data quality issues and solutions
  • quality assurance
  • feedback channels and evaluation

Primary responsibility: Valentina

Stories

  1. Best Practices/User engagement and collaboration throughout the lifecycle
  2. Best Practices/Feedback to Improve Quality
  3. Best Practices/Encourage crowdsourcing
  4. Best Practices/Open Data quality assessment
  5. Best Practices/Management Of A Wide Public Actors Network
  6. Best Practices/Making Research Results Open For The Country
  7. Best Practices/Using Business Process Paradigm For Open Data Lifecycle Management
  8. Best Practices/Supervizor - An Indispensable Open Government Application (Transparency Of Public Spending)
  9. Best Practices/Civic Use Of Open Data
  10. Best Practices/A Federation Tool For Opendata Portals
  11. Best Practices/Traffic Light System For Data Sharing
  12. Best Practices/Boosting citizens’ awareness through the reuse of existing resources
  13. Best Practices/Getting Journalists Involved In the Process Of Opening Up Data
  14. Best Practices/Infomediary Sector Characteristics
  15. Best Practices/Open Data 2.0 - Changing Perspectives
  16. Best Practices/Free our maps
  17. Best Practices/Raising awareness and engaging citizens in re-using PSI

Atomic BPs

External BPs

  1. Data Quality
    1. Provide data quality information

Documentation

Covering:

  • Documentation of information/data
  • creation of metadata.

Primary responsibility: Makx

Stories

  1. Best Practices/Human Readability and Machine Processing
  2. Best Practices/Stakeholders’ Interests and Rights
  3. Best Practices/Publication with Common Metadata
  4. Best Practices/Identifying what you already publish
  5. Best Practices/Management Of A Wide Public Actors Network
  6. Best Practices/Publishing Statistical Data In Linked Data Format
  7. Best Practices/A Federation Tool For Opendata Portals
  8. Best Practices/Traffic Light System For Data Sharing
  9. Best Practices/Open Data by Open Software in Szeged
  10. Best_Practices/The_Central_Role_of_Location

Atomic BPs

External BPs

  1. Metadata
    1. Provide metadata
    2. Provide descriptive metadata
    3. Provide locale parameters metadata
    4. Provide structural metadata
  2. Data Vocabularies
    1. Use standardized terms
    2. Use standardized terms
    3. Share vocabularies in an open way
    4. Vocabulary versioning
    5. Re-use vocabularies
    6. Choose the right formalization level

Selection

Covering:

  • Selection of information/data to be published according to various criteria.

Primary responsibility: Jan

Stories

  1. Best Practices/User engagement and collaboration throughout the lifecycle
  2. Best Practices/Stakeholders’ Interests and Rights
  3. Best Practices/Catalogs and Indexes
  4. Best Practices/Encourage crowdsourcing
  5. Best Practices/Management Of A Wide Public Actors Network
  6. Best Practices/Open Data Publication Plan
  7. Best Practices/Traffic Light System For Data Sharing
  8. Best Practices/Open Data To Improve Sharing And Publication Of Information Between Public Administrations
  9. Best Practices/Getting Journalists Involved In the Process Of Opening Up Data
  10. Best Practices/Opening Up Public Transport Information to Save Costs
  11. Best Practices/Infomediary Sector Characteristics
  12. Best Practices/Open Data 2.0 - Changing Perspectives
  13. Best Practices/Open Data Business Model Patterns and Open Data Business Value Disciplines
  14. Best Practices/An ongoing open dialog in an open data ecosystem
  15. Best Practices/Discover published information by site scraping
  16. Best Practices/Free our maps
  17. Best Practices/Open Data by Open Software in Szeged
  18. Best Practices/Open Data Monitoring and Benchmarking
  19. Best Practices/Raising awareness and engaging citizens in re-using PSI
  20. Best_Practices/The_Central_Role_of_Location
  21. Best Practices/Supervizor - An Indispensable Open Government Application (Transparency Of Public Spending)
  22. Best Practices/Civic Use Of Open Data

Atomic BPs

External BPs

Note the development of the Dataset Usage Vocabulary

Discoverability

Covering:

  • Self evident

Primary responsibility: Peter

Stories

  1. Best Practices/Human Readability and Machine Processing
  2. Best Practices/Optimization for Search Engines
  3. Best Practices/Publication with Common Metadata
  4. Best Practices/Publish spatial data on the web
  5. Best Practices/Identifying what you already publish
  6. Best Practices/Making Research Results Open For The Country
  7. Best Practices/Traffic Light System For Data Sharing
  8. Best Practices/Getting Journalists Involved In the Process Of Opening Up Data
  9. Best Practices/Infomediary Sector Characteristics
  10. Best Practices/Open Data Business Model Patterns and Open Data Business Value Disciplines
  11. Best Practices/The Central Role of Location
  12. Best Practices/An ongoing open dialog in an open data ecosystem
  13. Best Practices/DigMap- digital map excerpt
  14. Best Practices/Make the data available in the language people want it
  15. Best Practices/Raising awareness and engaging citizens in re-using PSI
  16. Best Practices/References to spatial entities

Atomic BPs

  1. Best Practices/For People to Read and Machines To Process ✔ but dupliacate
  2. Best Practices/Discover By Location ✔ but is it PSI D relevant?
  3. Best Practices/Promote PSI Re-use

External BPs

See section on documentation

Stories from the workshops

Initial set

  1. Best Practices/Cross Agency Strategy
  2. Best Practices/High Level Support
  3. Best Practices/Holistic Metrics
  4. Best Practices/User engagement and collaboration throughout the lifecycle
  5. Best Practices/Organisational-internal engagement
  6. Best Practices/Human Readability and Machine Processing
  7. Best Practices/Cost of Publication
  8. Best Practices/Stakeholders’ Interests and Rights
  9. Best Practices/Feedback to Improve Quality
  10. Best Practices/Optimization for Search Engines
  11. Best Practices/Publication with Common Metadata
  12. Best Practices/Catalogs and Indexes
  13. Best Practices/Encourage crowdsourcing
  14. Best Practices/Publish spatial data on the web
  15. Best Practices/Open Data quality assessment
  16. Best Practices/Identifying what you already publish

Samos workshop

  1. Best Practices/Management Of A Wide Public Actors Network
  2. Best Practices/Making Research Results Open For The Country
  3. Best Practices/Using Business Process Paradigm For Open Data Lifecycle Management
  4. Best Practices/Publishing Statistical Data In Linked Data Format
  5. Best Practices/Supervizor - An Indispensable Open Government Application (Transparency Of Public Spending)
  6. Best Practices/Civic Use Of Open Data
  7. Best Practices/Open Data Publication Plan
  8. Best Practices/A Federation Tool For Opendata Portals
  9. Best Practices/Traffic Light System For Data Sharing
  10. Best Practices/Open Data To Improve Sharing And Publication Of Information Between Public Administrations
  11. Best Practices/Boosting citizens’ awareness through the reuse of existing resources
  12. Best Practices/Getting Journalists Involved In the Process Of Opening Up Data
  13. Best Practices/Opening Up Public Transport Information to Save Costs

Lisbon workshop

  1. Best Practices/Commercial Considerations in Open Data Portal Design
  2. Best Practices/Infomediary Sector Characteristics
  3. Best Practices/Open Data 2.0 - Changing Perspectives
  4. Best Practices/Open Data Business Model Patterns and Open Data Business Value Disciplines
  5. Best_Practices/The_Central_Role_of_Location

Timisoara workshop

  1. Best Practices/An ongoing open dialog in an open data ecosystem
  2. Best Practices/Discover published information by site scraping
  3. Best Practices/Free our maps
  4. Best Practices/Open Data by Open Software in Szeged

Krems workshop

  1. Best Practices/Open Data Startups Accelerator

Berlin workshop

To be collected here

Google forms output

  1. Best Practices/Bottom-up organisation
  2. Best Practices/DigMap- digital map excerpt
  3. Best Practices/Encouragement via bonuses
  4. Best Practices/Open Data Bulk Download
  5. Best Practices/Open Data Monitoring and Benchmarking
  6. Best Practices/OpenMove - open platform for mobile ticketing
  7. Best Practices/Make the data available in the language people want it
  8. Best Practices/Raising awareness and engaging citizens in re-using PSI
  9. Best Practices/References to spatial entities

Template

This is the template to use for drafting Best Practices. The template itself is itself subject to change of course but reflects the discussion in Timisoara, 16 March 2015

You are likely to find this Google form useful as well as Noel's mind map

Doc To MediaWiki Converter is useful.

Title

The title of the Best Practice. On the wiki this is the page title and is included in the URL. This will be used to refer to BP. It should be effective in capturing the essence of the BP.

Short description

A short description of the BP. Typically less than a line long. The focus should on the intent behind the BP. It should answer the question "What particular problem does the BP address?"

Why

A brief summary describing the problem this BP is addressing, and the context in which it arises. How do I know that I need to follow a particular pattern? It may describe a scenario that illustrates the problem and explain how the BP solves the problem. It should also explain why the BP is important.

Intended Outcome

This is the key to the BP: what should be true when the BP has been implemented.

This section is unlikely to be long but should be very clear.

Relationship to PSI Directive

Each Best Practice should refer to one or more elements of the PSI Directive which was amended in 2013. See here for consolidated versions in all MS languages.

Possible Approach

This section may be longer and set out one or more possible ways to achieve the intended outcome.

It should include rationale of why this solution is better than the others

How to Test

Often quite short. In the case of Share-PSI BPs, it's likely that all tests will need to be carried out by people rather than machines but if something is machine testable, that's often more precise.

Evidence

We need a link to one or more places that provide evidence for this being a BP. This might be a specific paragraph in a workshop report or some other document.

It will often refer to examples of where the BP has been implemented, ideally with contact information for the team responsible.

Tags

List of terms describing the BP. Think of these tags as unstructured metadata helping others to search for or filter BPs.

Intended Audience

Describe the group of people for which the BP is designed for. Examples: business analysts, data managers, application developers, senior officials, strategy makers etc.

Related Best Practices

What BP are closely related to this one? What are the important differences? With which other BP should this one be used?