Code Monkey home page Code Monkey logo

api4h's Introduction

API4H

API4H means API for Humans, and defines a standarized way for webapps to offer a specific API that make's it possible to create alternative interfaces for people with accesibility needs.

Why

Maybe adding aria-tags and css media queries to a webapp whose UX experience has been designed for people without accesibility needs is not enough.

Sure they can turn an impossible to use interface into a usable one, but if you want to provide an optimized UX, a specific interface should be designed from scratch with the needs of the user in mind.

The role of API4H is to provice a standard way to find out if a site allows and makes it easy to create such alternative interfaces.

So imagine there is this site with great accesibility https://example.com and but still, you think the UX could be better for your specific needs. You just try to open https://example.com/API4H/index.md and bingo!, you can creat it. But before, take a look at https://example.com/API4H/interfaces.md because maybe the interfaze you are looking for is already there.

Basics

  • Documentation files must be simple and well structured markdown.

Basic Mandatory files

/API4H/index.md

It's the description of the site, what it's about and how to use it.

/API4H/versions.md

The list with the available versions available

/API4H/contact.md

The accesible contact information for the site. (email, phone, etc)

/API4H/legal.md

The accesible legal information for the site. (terms of use, privacy policy, etc)

API4H/interfaces.md

A list with the alternative interfaces available.

Version mandatory files.

/API4H/versions/1.0.0/index.md

The description of the version. What you can do with ths version

api4h's People

Contributors

hacknlove avatar

Stargazers

Ángela Antúnez avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.