Stream: IG creation
Topic: ig-guidance
Jay Lyle (May 27 2021 at 17:17):
I don't see a Suggest a Change link in there, nor do I see any JIRA items for "ig-guidance," but a suggestion:
I often have difficulty figuring out what an IG is for. Explicit description of the functionality, either with use cases or references to DAMs or other requirements assets, will help people not involved in the IG creation understand what it's for and how it fits in the landscape.
John Moehrke (May 27 2021 at 18:01):
good point on the lack of way to report an issue. Put issues in github https://github.com/FHIR/ig-guidance
Grahame Grieve (May 28 2021 at 10:34):
I often have difficulty figuring out what an IG is for
How is this not the proper first narrative for a guide home page? Is it that they're not trying, or they're not communicating to you?
John Moehrke (May 28 2021 at 10:36):
I think so. but I think the point is that IG authors are not thinking about the reader that comes at their spec cold
Grahame Grieve (May 28 2021 at 10:38):
well, surely they should be?
Jay Lyle (May 28 2021 at 18:36):
- Yes, the introduction should be clear. We could put that in the guidance, too. I think they are trying, but they have unrecognized assumptions.
- If there is actual documented business analysis, it should be easy to point to. If not, it's that much more important to get it out of the designer's head to where everyone can see it.
Jose Costa Teixeira (May 28 2021 at 20:39):
We can provide some guidance but everyone will have their flavour
Jose Costa Teixeira (May 28 2021 at 20:40):
We can enable features. But we cannot say how people shall organize their information
John Moehrke (May 28 2021 at 20:41):
I think the only thing being asked for is a reminder to authors to have a simple statement of purpose on the index.html
John Moehrke (May 28 2021 at 20:42):
HL7 could mandate that this simple statement of purpose was exactly the same as the IG description in the IG Registry
Grahame Grieve (May 30 2021 at 21:38):
That is size limited, and limited to text, so it should not be exactly the same. But it should be functionally equivalent, I agree
Last updated: Apr 12 2022 at 19:14 UTC
