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
Labels
Usability
Usability bugs and issues
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
The text was updated successfully, but these errors were encountered: