Application programming interfaces (APIs) are software interfaces that expose defined functionality to developers writing programs. API documentation describes these software interfaces.

learn more… | top users | synonyms

3
votes
0answers
52 views

Good Examples of and Practices in Code Documentation

I noted in this question What is the best way to learn technical writing? that a rated method to learn how to write technical documents is to imbibe good examples. Can you recommend any examples ...
5
votes
4answers
357 views

How can I write better code-based reference documentation for programming interfaces?

Programmers can write comments in code that can be automatically turned into API documentation (like Javadoc). All I have to do is add some comments explaining what a class or method does and what ...
2
votes
2answers
185 views

API reference doc: best practices for describing opaque parameters?

The reference documentation for an application programming interface (API) is, in modern systems, usually generated from the code itself automatically. For example, for Java interfaces a typical tool ...
2
votes
1answer
2k views

Mashery vs. Apigee

I was wondering if anyone could lend some advice as to the pros and cons between using Mashery versus Apigee for documenting an API? I have do some evaluating and have about 2 weeks to come up with a ...