Stream: implementers
Topic: Documentation UX: Resource Content
Josh Mandel (May 31 2019 at 22:55):
I've kicked off a bit of user-experience research on the FHIR spec, and one thing I've found is that our Resource Content insets appear pretty far (and variably far) down the page. That is, insets like this one for AllergyIntolerance:
Please vote here on whether you like the idea of moving these Resource Content insets up toward the top of each resource page, so they'd sit beneath just a short scope/usage section.
Vadim Peretokin (Jun 01 2019 at 04:38):
"Just give me the model to shove data into and some examples to help figure it out" - I don't favour encouraging that _too_ much
Josh Mandel (Jun 01 2019 at 13:29):
I think we need to be realistic about how people use our specifications. We have far, far more text than anyone will ever read, and the "Resource content" is what new and experienced users both seek out most often.
Vadim Peretokin (Jun 01 2019 at 14:24):
Since we have Javascript on the page already, we can also limit how much scope & usage is displayed - that is, don't always display it at full length
Jose Costa Teixeira (Jun 01 2019 at 14:44):
In one prototype for rendering I experimented with jQuery accordion. Is that the kind of solution you are pointing at?
Jose Costa Teixeira (Jun 01 2019 at 14:45):
If we do change it, can we also look at making /keeping it print-friendly ?
Jose Costa Teixeira (Jun 01 2019 at 14:45):
Perhaps printing is not expected for the standard. It's just an idea
Eric Haas (Jun 01 2019 at 18:43):
As I underastand it per ISO standard rules can't hide content behind buttons...
Lloyd McKenzie (Jun 01 2019 at 19:13):
I don't think hiding the text is a good idea. What might be useful is if we constrain the scope and usage to a couple of paragraphs and put a table of contents to the right. That would move the resource definition up and would also give people a quick overview of the key parts of the guidance that exist and let them jump where they want without scrolling
Jose Costa Teixeira (Jun 01 2019 at 21:54):
Makes sense - normative materials should be displayed in full . a standard ToC makes sense
Lloyd McKenzie (Jun 01 2019 at 22:02):
It wouldn't necessarily need to be a standard ToC. It would list the headings for whatever 'note' headings exist.
Last updated: Apr 12 2022 at 19:14 UTC
