We have been pulling together a backlog of practical knowledge for which we can provide documentation.
See this spreadsheet, and the table below for a set of examples.
We’d like to hear from members of the community – what’s missing? What’s a high priority?
Do you have any documentation that you’ve produced through your own projects, which might be valuable to others in this community? Let us know!
#
| Name | Purpose | Type |
|---|---|---|
| Generating profiles | Instruct users on how to generate profiles (to accompany “HSDS Profile Wizard”?) | How-to |
| Mapping schemas to HSDS | Instruct users on how to map their schemas to HSDS, using the mapping template as example (to accompany transformer) | How-to |
| Validating compliance with HSDS | Instruct users on how to validate compliance with HSDS (to accompany the HSDS validator?) | How-to |
| Bootstrapping a database with HSDS | Instruct users on how to bootstrap a database from the HSDS schema (to replace the SQL dump?) | How-to |
| Serializing contact information | How to delineate different types of contact information using the Attributes table. | How-to |
| Schemas and API spec | Explanation for relationship between schemas and API spec | Explanation |
| Using the Attributes table | Explanation | |
| Program > Services > Secondary services | Educate users on the nuances of these concepts and how they can be applied to structure complex service information | Explanation |
| Working with spreadsheets | Guidance for working relational data into and out of ‘flat’ structures. | Tutorial |
| Concept model > logical model | Clarifying the relationship between the concept model and logical model | Explanation |
| Authoring a “data guide” | Guiding users for producing a “data guide” to accompany their API / open data | How-to |
| Designing data partnerships (non-technical) | Guiding users through the process of designing equitable and sustainable data partnerships | Tutorial |