Ensure API Readme is understandable to non-technical staff

hurricane-response / florence-api

Fork of https://github.com/sketch-city/harvey-api for Hurricane Florence

https://hurricane-florence-api.herokuapp.com/

GNU General Public License v3.0

50 stars 14 forks source link

Ensure API Readme is understandable to non-technical staff #47

Closed GovInTrenches closed 5 years ago

GovInTrenches commented 6 years ago

We should review the documentation to make sure that if we're making it readable for non-technical staff. Specifically, if a member of FEMA or other disaster organization reads this, it should be clear what this actually does in plain English.

We should also keep in mind that they'll be other Code for All partners around the world that might be looking at this too and so our docs need to be super-readable

Kaushl2208 commented 6 years ago

Can i work on this?? @GovInTrenches

miklb commented 6 years ago

Yes absolutely. We would love your help. Let us know if you have any questions.

Kaushl2208 commented 6 years ago

@miklb @GovInTrenches can you take a look to the pr??

omnilord commented 5 years ago

@GovInTrenches feel free to re-open this if you think we missed anything with #93