08 - Documentation

An overview of the information found within Tenon's documentation. [05:28]

Transcript

  1. At present, all of Tenon's documentation is available here, under Docs. The documentation that we have is solely oriented around the API itself. As soon as you get here, you're presented with a bunch of documentation. I'm going to go through each of these and talk about them at a high level.
  2. The Quick Start is, as the name implies, the very, very quick start on using the API. It talks about the steps necessary to register and grab your API key. Then it presents you with a series of example requests.
  3. For instance, you can use this one within terminal, within your Mac terminal or other command line environment, to submit the request with cURL. We have a PHP and cURL example, Python 2, Python 3, Node.js, and so on. Then we provide links to some of the additional bits and pieces.
  4. These are really quick, meant to get you up and running on the API. Then we go through a little bit more detail as we get through these documentations.
  5. The overview itself is a little bit more detailed textual information, how to submit a request, where to submit them, and some other high level things. This talks about the required and optional parameters for the API.
  6. For instance, your required parameters are going to be your API key, of course, and either your URL or the source. All of our optional parameters are listed here, and detailed with information about what's required, what the valid formats are, and things like that.
  7. Under API Response, we talk about the specific keys and format of the API Response, providing an example here of that response.
  8. Over at Response Codes, we talk about the specific response codes and response messages that Tenon will give you for success and for failure, and fully document those.
  9. Issue Reports contains a detailed description of all the different bits and pieces of each issue that's in the result set.
  10. What Tenon Tests, gives you a full list of all of the specific tests that Tenon provides, including the number of tests. We also transparently disclose those WCAG success criteria that Tenon does not or cannot test for.
  11. The Change Log provides you with a full list of changes that have been made to Tenon. We provide this information, again, as part of our transparency efforts. We disclose whether something was an improvement or a bug, where it was made, what the issue number was, and the title.
  12. We provide these issue numbers because sometimes people will contact us, they'll let us know about something, maybe a feature request or a bug. We will tell people when we create those issues, what they are, and then they can come back here and check them out.
  13. Accessibility of Tenon, this is the Home page for the Accessibility. We have a list of the currently known accessibility issues that we're aware of and tracking. We also provide a VPAT and, what I called a, WCAG PAT which is a VPAT format that uses WCAG as the success criteria.
  14. The VPAT stands for, for those who don't know, the Voluntary Product Accessibility Template. It discloses information about the level of accessibility of the product, when assessed against the Section 508 standards. It contains the criteria supporting statement and any remarks and information, explanations here. We have the similar format for the WCAG standards. We'll talk about that there.
  15. Finally, a little bit about Privacy and Security here at that link, and all of the legalese you can handle on our terms of service. So that's the documentation of Tenon. We are well aware of the fact that we need to document the UI and the UI based features a lot better, but that's what we have for now.