This repository was archived by the owner on Nov 6, 2025. It is now read-only.

Documentation

Jump to bottom

Anallely Olivares edited this page Aug 3, 2014 · 2 revisions

Tools to assist in documentation:

YAML/RAML
Swagger
Slate
API Doc JS
.NET - Help Page
Sphnx
Header Doc
APIARY - API Blueprint
AGILO
Smart Docs (Apigee)

Listing of items to consider to include in your documentation

Audience (aimed to developers? product owners?, etc.)
Versioning
Quick Start Guide
Authentication/Handshake
Code Examples (Curl, etc)
Limits (Throttling/etc.)
Error Handling
API Status page (Up/down)
Feedback (Form/analytics)
Licensing

Additional Resources:

http://conf.writethedocs.org/