search

adlnet / xAPI-Spec

The xAPI Specification describes communication about learner activity and experiences between technologies.
https://adlnet.gov/projects/xapi/
901 stars 405 forks source link

Likely Common Abbreviations Should Be Made Explicit #977

Closed oconnetf closed 8 years ago

oconnetf commented 8 years ago

In the Definitions, Learning Record Store is give "LRS" as an abbreviation parenthetically, as are a number of other terms.

Since 1.0.3 introduces "Learning Record Provider" and "Learning Record Consumer", it seems like we might want to go ahead and introduce "LRP" and "LRC" as expected abbreviations.

The only use of the abbreviated forms I could find in any section was in the newly added images, suggesting that they are now in common enough usage outside the spec that they could become more common inside the spec.

There's a related issue (which could be considered separate) that the spec spells out "Learning Record Provider" several times throughout the text but uses "LRS" as a preferred abbreviation.

I could buy this as intentional style for new terms (LRS has been around for a long time by now), but internal consistency might come to seem more natural by a post-1.0.3 version.

garemoko commented 8 years ago

+1 to adding LRP and LRC to definitions

Regarding use of LRP and LRC being less common that LRS in the spec, if this needs to be more consistent, I'd prefer to move occurrences of LRS to Learning Record Store than reduce Learning Record Provider to LRP in more places.

oconnetf commented 8 years ago

I don't know that the consistency matters terribly, but I do know that as I write about any of them, I instinctively prefer to abbreviate after the first instance.

andyjohnson commented 8 years ago

I think putting them in the definitions is a good idea. I'd like to ease people into the concepts more via repetition and I don't mind if the acronyms are used, but I think it should happen organically and I don't think we should replace the full text with acronyms. We spell out Learning Record Store quite a bit in the spec, despite the acronym being common. There are very few instances of Learning Record Consumer.

On Mon, Aug 15, 2016 at 8:38 AM, oconnetf notifications@github.com wrote:

I don't know that the consistency matters terribly, but I do know that as I write about any of them, I instinctively prefer to abbreviate after the first instance.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/adlnet/xAPI-Spec/issues/977#issuecomment-239791976, or mute the thread https://github.com/notifications/unsubscribe-auth/ABQ36yuAX_77OdxAjcVlrImahoRdN6Pfks5qgF3egaJpZM4JjmHB .

Andy Johnson ADL Technical Team 608-318-0049

garemoko commented 8 years ago

@oconnetf Are you happy that #978 addresses this?

oconnetf commented 8 years ago

I am. :) #978 already had enough 👍s...

oconnetf commented 8 years ago

I realize I wasn't explicit: safe to close this one.

garemoko commented 8 years ago

@oconnetf you can do it! (As the creator, you have permission to close the issue)

oconnetf commented 8 years ago

Ha. Wasn't sure of cultural preference.