Stream: IG creation
Topic: Exemplary FHIR IG
Corey Spears (Jul 28 2021 at 21:32):
I am working on updating the Da Vinci Formulary IG to have a better navigation. I know there has been a push lately to harmonize the structure of IGs a bit more in order to make them useful. Is there a set of guidelines or exemplary IGs that we might use to guide our improvements?
Lloyd McKenzie (Jul 28 2021 at 22:32):
I don't know of one that would be 'exemplary', but the general rules are:
- minimize the number of pages, and ensure where you split pages that each has a clear purpose and doesn't require much navigation to use it
- separate out "backaground" content that could theoretically be skimmed/ignored from the 'hard' conformance requirements
- ensure that all important pages are navigable to from the menu and that all other pages are directly linked to from the text of the pages in the IG.
- it should be possible for someone to fully navigate your IG without ever clicking on next/prev or ToC.
- make liberal use of hyperlinks. Assume that someone might start on any page of your IG, so make it easy to navigate from wherever they start to the key things they need to know.
Last updated: Apr 12 2022 at 19:14 UTC
