Date: xxxx yy, 20yy
Author email: xxx
Profile ID: version control with regards to the profile identifier – you can use this web site for simple working notes, but serious work and proper version control, it is better to use the Github repository at https://github.com/adlnet/xapi-authored-profiles – notes on the Profile authoring process can now be found at http://xapi.vocab.pub/resources/index.html#getting-started
(Note, Valerie will work with legal to develop a version that is not XML specific)
Acknowledgements (placeholder for later – will list all working group members)
Introduction (explain the need the profile is meeting, it’s scope, the relationship to xAPI, and the relationship to other profiles and or standards. Link to xAPI overview. We may want to reference any important publication tools the profile leverages, or that might be better in the verbs section.Cite the relationship between statement structure and what is possible with analytics.)
Can be categorized by situation type or by activity type, or whatever makes sense in that context. Note that Recipes are a structure which seems specific to the original Tin Can API from Rustici and are likely to be deprecated.
Recipe-specific recommendations in whatever structure makes sense. suggestions about use of Result, Context or State API, Agent Profile, etc.
Descriptive material that may contain recommendations for what in a virtual patient activity is considered an activity and how it is identified. If activity types are needed, this section can include a list of activity types. At a minimum, if the activity is the VP, we should make that explicit and provide a recommendation as to what to use for the identifier for a VP.
Could contain human readable versions, then the JSON representation
- (may contain or reference the verbs used in this profile, their label, description, id, closely related term, and vocabulary. )