As an agency user, I would like written documentation about how to use the broker

18F / data-act-pilot

This small DATA Act pilot contains code that translates agency data to a uniform DATA act format.

Other

21 stars 14 forks source link

As an agency user, I would like written documentation about how to use the broker #169

Closed bsweger closed 8 years ago

bsweger commented 8 years ago

Acceptance criteria:

[x] Step-by-step instructions for using the pilot broker

bsweger commented 8 years ago

Include information to set expectations for people using the sandbox (we don't store files, it's set up to process the original 83 data elements)

bsweger commented 8 years ago

Propose updating the project's current README.md to include just a brief introduction followed by links applicable to specific use cases:

Federal users: how to use the website
Federal users/public: how to ask a question or provide feedback
Tech users: how to install/run the project locally, other info about technology/architeture
Federal users/public: pilot background and context

bsweger commented 8 years ago

Who should folks contact if they need credentials for the hosted version of the pilot website?

bsweger commented 8 years ago

In addition to the fact that this pilot uses fewer data elements than shown in Treasury's Data Element Guidance, there's another inconsistency: we have awardee attributes as part of the part of the awards.csv instead of having them in a separate file.