[Framers] OT-Documenting APIs

[Shmuel Wolfson]

Just to add to what others have mentioned, I did a search for "API 
documentation" on Udemy.com and there is a nice list of API courses:
https://www.udemy.com/courses/search/?q=api%20documentation

I think there are two different types of APIs:
1. A list if software functions
2. Web-based commands that allow you to interact with website applications

The two types seem very different. I write software reference manuals 
that are like #1 above, but the API documentation examples here don't 
look anything like what I write:
https://github.com/PharkMillups/beautiful-docs

Could someone verify if this is correct or not?

--
Shmuel Wolfson
Technical Writer
058-763-7133


On 22-Nov-17 10:22 PM, A Craig wrote:
> I'm writing the list because I hope someone here can answer my OT question.
>   
>
> I'm currently doing contract work while I search for a new full-time job.
> The problem (for me) is that a *lot* of Tech writing jobs here in the
> Vancouver, Canada, area include documenting APIs. Unfortunately, I have zero
> experience in this area.
>
>   
>
> Given this fact, I'm wondering if anyone knows of an online course(s) I
> could take to how to do this.
>
>   
>
> If anyone has any suggestions, feel free to answer me off-list:
> acraig at shaw.ca <mailto:acraig at shaw.ca>
>
>   
>
> Alison Craig
>
>   
>
> _______________________________________________
>
> This message is from the Framers mailing list
>
> Send messages to framers at lists.frameusers.com
> Visit the list's homepage at  http://www.frameusers.com
> Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
> Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
> Send administrative questions to listadmin at frameusers.com
>