Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove standard content, add example #18

Merged
merged 5 commits into from
Apr 15, 2020
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 24 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,53 @@
# Documentation details
jpmckinney marked this conversation as resolved.
Show resolved Hide resolved

Contracting processes involve many different documents. There should be a presumption of 'open by default' when it comes to publishing these documents as part of an Open Contracting process.

The OCDS documentation block, which is used widely through the different sections of the standard, provides a means to link out to externally hosted documents.
jpmckinney marked this conversation as resolved.
Show resolved Hide resolved

These should generally be provided at their own stable URL, without requirements to log-in or authenticate. Redactions should be kept to a minimum.

## Providing enhanced documentation and document links
jpmckinney marked this conversation as resolved.
Show resolved Hide resolved

A number of implementations of OCDS, notable OCDS for PPPs, explicitly require a number of key items of information to be disclosed. These items are articulated as an extended list of entries for the `documentType` codelist.
jpmckinney marked this conversation as resolved.
Show resolved Hide resolved

However, rather than just linking out to the entire document where the information is found, this extension describes a way to:
jpmckinney marked this conversation as resolved.
Show resolved Hide resolved

* Summarize the information in the `description` field of the relevant document block;
* Link to specific page numbers;
jpmckinney marked this conversation as resolved.
Show resolved Hide resolved
* Describe any additional arrangements required to access the document or find the relevant information;
* Record the author of the document;

Providing clear summaries allows applications to display this information in a user-interface, allowing users to access key facts and justifications without clicking through to download and search for the information in a full document.

Linking to the specific page where information is found supports quality assurance of disclosure.
jpmckinney marked this conversation as resolved.
Show resolved Hide resolved

Describing `accessDetails` for a document ensures that, even when documents are only accessible through attendance at a location (for example), that users can find how to discover them - and so that auditors can check documents have been made accessible in the appropriate ways.
jpmckinney marked this conversation as resolved.
Show resolved Hide resolved

Recording the author of a document is important for checking whether there are potential conflicts of interest to be aware of: for example, when the author of a feasibility study is later involved in the team submitting a bid.
jpmckinney marked this conversation as resolved.
Show resolved Hide resolved

## Example

```json
{
"documents": [
{
"id": "1",
"documentType": "equityTransferCaps",
"title": "Equity transfer cap terms",
"description": "No equity transfer is permitted until construction is completed. See document for more details.",
"url": "http://example.com/ppp_unit/documents/contracts/4g_network_signed_contract.pdf",
"pageStart": "334",
"pageEnd": "336",
"accessDetails": "You must register for document access via the following url: http://example.com/ppp_unit/registration/",
"author": "Contract department, PPP unit"
}
]
}
```

## Issues

Report issues for this extension in the [ocds-extensions repository](https://github.com/open-contracting/ocds-extensions/issues), putting the extension's name in the issue's title.

## Changelog

### 2019-07-24

* Remove references to core fields from README.md

### 2019-01-30

* Remove obsolete `mergeStrategy` properties