Warning:
This wiki has been archived and is now read-only.

Best Practices/Different publication formats for both human readers or for machine processing

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

Outline

Different publication formats for both human readers or for machine processing

Management summary

Challenge

Mistakes and confusion due to information that is hard to understand are common experiences of many people. Similarly, the additional cost of developing systems that use badly-documented interfaces is a commonplace in the world of information technology. Human readership and machine processing are both important but require different publication formats

Solution

Published information that can be understood by human readers and effectively processed by machines as appropriate.

Best Practice identification

Why is this a Best Practice?

Creation and publication of standard human and machine readable PSI

Links to the PSI Directive

Publication and deployment of information

Why is there a need for this Best Practice?

Human readership and machine processing are both important but require different publication formats.

What do you need for this Best Practice?

  • Publishers MUST consider whether the published information will be read by humans, interpreted by computer programs, or both
  • Information that is to be read by humans SHOULD be prepared so that its intended audience can read and understand it easily.
  • It CAN be made available in parallel versions in different languages.
  • It MUST follow the grammatical rules of the languages concerned.
  • It MUST use open standard data formats that can be interpreted by reader programs that are widely available from multiple sources and are likely to remain so for the lifetime of the information.
  • It SHOULD use open standard data formats that can be interpreted by reader programs that are available free of charge.
  • Information that is to be interpreted by computer programs MUST use open standard data formats.
  • The formats concerned MUST be identified, and their application to the information MUST be explained.
  • Access mechanisms, for example for authorization of the accessing human or computer system, MUST be clearly documented.
  • Readability of information to be read by humans SHOULD be tested by reviewing it. The effort expended on review CAN vary to reflect the importance of the information.
  • Suitability of data formats used for information that is to be read by humans or interpreted by computer programs CAN be tested by design reviews.
  • Ability to access information SHOULD be tested by making trial accesses.

Applicability to other Member States

The approach is applicable to any Member State.

Contact info

Missing