: Re: What is special in API documentation compared to general technical writing? The title says it all: what is special in Application Programming Interface documentation compared to general technical

@Heady158

Vote Up Vote Down

In one sense you could say, Nothing. All technical writing should be clear, give good examples, etc.

The main thing that comes to my mind is that for an API, you pretty much have to have the bulk of the document be reference. That is, you have to list all the API calls, give all their parameters, etc.

It would be a really good idea, by the way, if you actually explained what each call does and what all the parameters are and what they're for. I've read several API docs that just list function names and parameter names and data types and that's it.

(0)

Login to post a comment!