Instructor: Our next topic is API Documentation.
Now, let's begin with an exam.
Nobody likes to write documentation.
I have yet to meet a developer that told me happily,
"You know what I'm going to do today?
"I'm going to write documentation."
Yeah, it's never gonna happen.
But even though nobody likes it, it is so important.
Your API must be well documented and let's think why.
So let's begin with a question.
In your opinion
how many developers will use an undocumented API?
So think about it for a minute and let's go to the answer.
So the answer for this question is probably this.
No one.
Nobody is going to use an undocumented API,
unless of course you force the developers to do it.
But most of us are not in this position.
And in general, no matter how good your API is,
how sophisticated it is,
and how great the execution is,
if it is not documented,
then simply no one will use it.
So when talking about the importance of the documentation,
of course it is crucial for the API usage.
You want developers to use the API, then document it.
In addition, the documentation
will make it much easier to use.
And if you remember,
one of the key factors for making other developers
to use your API is to make it easier to use it.
Good documentation attracts developers.
If developers sees that the documentation
is comprehensive and detailed
and really helps them to understand what the API is doing,
then they will come in droves.
In addition, good documentation improves your image.
Once the documentation looks professional
and provides answer to all the questions,
then the typical developer will assume
that the developer behind the API is also professional
and is probably someone he should work with.