3
votes
1answer
1k views

What is the general format of a Software Design Specification?

I'm trying to document a piece of software I wrote in detail. An SAS is too high level and doesn't cover the API. I found several examples of an SDS online, but I don't see a trend in their format. ...
1
vote
2answers
190 views

Questions to ask a 3rd party API provider [closed]

I'm due to meet with a developer/sales person from a new 3rd party resource we're about to start using. The main topic I'll be interested in, is their API as I will be the developer making use of it ...
3
votes
1answer
118 views

How to automate the API Diff document? [closed]

We can use doxygen to do the documentation, but how can I do the API Diff? Any open source or free solution for that? Or I need manually prepare? Thanks.
8
votes
3answers
162 views

How to document experimental or incomplete APIs like @deprecated?

Is there a good term that is similar but different than "deprecate" to mean that a method or API is in the code base but should not be used because its implementation is not complete or will likely ...
5
votes
2answers
2k views

How to document requirements for an API systematically?

I am currently working on a project, where I have to analyze the requirements of two given IT systems, that use cloud computing, for a Cloud API. In other words, I have to analyze what requirements ...
1
vote
2answers
717 views

How do I read API documentation?

I've been trying to read through the RoR API to try to learn things that the tutorial missed, and I haven't been able to follow it at all. The only time I've read documentation was when I needed to ...
1
vote
3answers
444 views

how to layout good documentation [closed]

I need to write out a documentation for developers to be able to use some API web software how should i lay out a documentation? What should always be included? And does it need to be really long or ...
5
votes
2answers
373 views

Are there any C API explorers/browsers out there that include the GNU C Library methods and data structures? [closed]

I am looking for something similar to the Java API documentation, but for the GNU C Library. I am trying to develop a simple server/client Sockets program but I keep getting lost in the different ...
2
votes
1answer
483 views

Open Source Web-based CMS for writing and managing API documentation

This is a question that have somewhat been asked before (i.e.: How to manage an open source project's documentation). However, my question is a little different because: We're not developing open ...
1
vote
2answers
181 views

How to use the APIs for different platforms?

From what I know, learning a programming language consists of : 1- Learning the syntax 2- Learning how does the language handle\use\implement its "abilities" (Classes, delegates, structs, ...
9
votes
4answers
686 views

How are undocumented functions discovered?

I've always wondered how do you find undocumented / private API ? Example the Apple undocumented / private API, Play Station, Windows Phone 7, Win32 Kernel, Windows API, hidden callback, etc... ...