Skip to content
This repository has been archived by the owner on Feb 4, 2022. It is now read-only.

Reach API: users won't understand the difference between 'Citations' and 'policy-doc's as it is currently written out #492

Open
aoifespenge opened this issue Apr 16, 2020 · 0 comments
Labels
Usability Usability bugs and issues

Comments

@aoifespenge
Copy link

aoifespenge commented Apr 16, 2020

In the same way we say usability issues in understanding the relationship between the two functions on Reach - citations and policy docs, I'm certain that API users will have exactly the same problem. At the moment it is written for someone who already knows what Reach does.

I would say this issue is quite important, if we don't want users feeling at a loss or needing to contact us to understand.

It can improve in a couple of ways. My suggestion is that the two concepts are explained within the API and then referred throughout the API with keywords with link back to the original explanation.

More info https://www.notion.so/wellcometrust/Reach-API-usability-Analysis-and-recommendations-e1a5a76806b347ba9ba784e550b4ce7d

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Usability Usability bugs and issues
Projects
None yet
Development

No branches or pull requests

1 participant