wellcometrust / reach

Wellcome tool to parse references scraped from policy documents using machine learning
MIT License
26 stars 4 forks source link

Reach API Usability improvements #494

Open aoifespenge opened 4 years ago

aoifespenge commented 4 years ago

Based on guidelines for API usability best practice, Sam and I went through the Wellcome Reach API experience and identified some important changes that should be made to make sure this API is easy to use. All the recommendations are here: https://www.notion.so/wellcometrust/Reach-API-usability-Analysis-and-recommendations-e1a5a76806b347ba9ba784e550b4ce7d

I've added the most important ones to Github as issues under this epics. Lots of these changes are easy to do, but would be impactful.