"UseMe" standard

+2  

The "readme.txt" equivalent for machines.

YAML Idea

Be it files in a repo, or an API resource, or a physical machine -- all of them have manuals of usage of some sort:

  • if it's a machine, that operation manual comes in form of a book, help file or reference manual,
  • If it is an API, the instructions may come in its schema response,
  • if it's a repo, it often comes as readme with some Makefile, that implements a kind of callable interface to the repo itself.

It would be great if we could start using these interfaces in a sort of plug-and-play fashion, that we can use things like mouse or keyboard.

Here's where "UseMe" standard would come in -- we would choose a general interface description language, and use it to describe systems and subsystems of all sorts, using the machine-readable UseMe format, that would work like an abstraction layer on top of those various operation manuals, Makefiles, API schemas, and other type of interface descriptions.

Just like we have a "readme.txt" for humans, we might want to have "useme.txt", and in fact, the UseMe could even be integrated as part of readme files, by having a special section with a special tag like %USEME%, that would allow the developers and engineers inject updated interface specifications into ReadMe itself.

All kind of APIs (GraphQL, REST, SOAP, XML-RPC, etc.) would return not their schema, but the UseMe response.

Considerations:

  • The UseMe response could be linked to data sources using a standardized key, like specified in polycontext metasymbol.
  • The UseMe response could include use vocabularies to add semantic meaning to resources, like specified in Automated API traversal.

This would allow people and machines to interface with systems directly with flat learning curve.

So many medical test results come with their own reading and viewing software, that while providing extra value for doctors, do not make it easier to analyze the datasets, just because there is that little bit of learning curve to familiarize with an API, field names and meanings. This "Time-To-Use" and "Time-To-Data" and "Time-To-Value" would shrink as a result.


+[link]


--Mindey,


+[project]
Silently (suppress notifications) Remember (Optional)   Please, log in.

Could such UseMe standard help also describe various social resources? Companies and individuals, when working professionally, tend to package their services and products in some standardized ways of requesting them and standardized processes of their fulfillment for the sake of efficiency and professionalism. Perhaps the UseMe standard could extend to describing the preferred ways of interacting with each others through Operation Requests, and even help quantify those interactions.


--Inyuki,

+[comment]