openreferral / specification

The Human Services Data Specification - a data exchange format developed by the Open Referral Initiative
https://openreferral.org
Other
117 stars 50 forks source link

Update FAQs (3.0) #341

Closed lgs85 closed 10 months ago

lgs85 commented 1 year ago

We will need to update the FAQs page to be consistent with the 3.0 upgrade. For example, the section about the format of HSDS is out of date.

greggish commented 1 year ago

This is on my list of things to do. I think we might end up consolidating the FAQ on the website with this FAQ, and restructuring it so that different sets of Qs can be presented in different contexts. Would welcome your input into what we should update and any other questions we should add to answer.

lgs85 commented 1 year ago

Thanks @greggish that's good to know. I'll have a full read of the website and docs FAQs and come back with some thoughts.

lgs85 commented 1 year ago

@greggish from a 3.0 perspective, I think that the only questions that need updating are the ones on format, and on taxonomies. The latter is just some broken links I think. The format question is on both the website and the docs, and will need to reflect the change in format of the schema.

I don't see an urgent need for additional technical FAQs at this stage - hopefully we can make the reference clear enough in of itself. It might be useful, though, to think about a high level question about the approach to the API spec, and how this interacts with HSDS.

I'm happy to help with editing the format question, and/or to help with adding, removing and editing initiative-level questions from the docs site if that's part of your intended work. Let us know what works best for you. @dan-odsc

dan-odsc commented 1 year ago

@mrshll1001 - Updates to FAQ's are as follows: