Re: [Framers] OT-Documenting APIs

2017-11-23 Thread Robert Lauriston 
The kinds of API docs I would distinguish are:

1. generated from source code using native tools (e.g. javadoc and pydoc)
2. generated from source code using native code comments and a
third-party tool (e.g. Python docstrigs + Sphinx)
3. generated from source code using third-party tools (e.g. C++ &
Doxygen, REST & Swagger / OpenAPI)
4. generated from doc source in the same codeline as the source code
(e.g. Markdown + static site generator)
5. not generated from source code, tech writer just works with the
developers to sort it out

There's overlap among those categories, especially 3 to 5, but I think
from a tech writer's point of view those are the major variations in
workflow. 1-3 guarantee accuracy in certain aspects of the docs:
deprecated code will automatically be removed, and new code that has
not been documented yet will typically result in obvious holes so
you'll know you need to fill them in.

I think #4 became popular because developers chose REST over javadoc
to avoid the time and effort required to support generating the docs
from the source. In the long run, that's not cost-effective and leads
to inferior docs, which is why Swagger has caught on.

On Thu, Nov 23, 2017 at 2:59 AM, Shmuel Wolfson  wrote:
>... 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 ...
___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com

Re: [Framers] OT-Documenting APIs

2017-11-23 Thread Grant Hogarth 

Hi Shmuel
You are correct.  The second form are usually called REST or RESTful 
applications.
The main difference from our perspective is that for the REST type, you 
really do need to provide a lot more "recipes" for how the various HTTP 
requests (GET, POST, PATCH, DELETE, HEAD, OPTIONS, etc.) are used, and 
which requests are and are not supported.
This is because the same API will behave (and respond) differently 
depending on the type of request being made. A GET, for example, only 
returns information from the target, while a POST or PATCH will change 
the target.
A use case (highly recommended), should show how a user would make a 
request using a GET to retrieve information (for example, the name of 
the resource), and then use a PATCH to change the name.


For my own purposes, I define an "Example" as a single use of a command 
or call/request, and a "Use Case" as a collection of commands/calls that 
show how the user would achieve a desired task. By analogy, a Use Case 
is a routine that is composed of subroutines, while an Example would be 
a single-operation sub-routine.


Does this help?
Grant

-- Original Message --
From: "Shmuel Wolfson" <shmue...@gmail.com>
To: framers@lists.frameusers.com
Sent: 11/23/2017 3:59:55 AM
Subject: Re: [Framers] OT-Documenting APIs

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



___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com

Re: [Framers] OT-Documenting APIs

2017-11-23 Thread Grant Hogarth 

Hi Allison.
I've done a fair bit of API documentation, so feel free to ask me 
questions.


The thing to remember is that basically an API doc is a cookbook. You 
are providing the recipe and cooking instructions.


Most APIs these days are in some variant of XML (XML, YAML, YANG, etc.), 
so being comfortable reading XML is a good start.  W3schools has really 
good reference material.


The other big thing is being able to read the source material and parse 
it out.
XSD files are often used for these, but so are .yang and .json files. 
yang.org and json.org have good references.

There are two significant areas for TWs in the source.
1) the Description section.  This should clearly explain what the 
element being described does.
2) the criteria section. This is basically everything else in the 
element description.  While some programmers are really OCD about doing 
a complete set, others are lazy (or have been distracted).

At a minimum, you need to check for
* name
* type (uint, date, string, etc.)
* units (if required)
* optional/required
* values and restrictions This can get broken out as min/max values, 
default, special values (such as -1), etc. These may be separate items 
or a single item.  You will often find this information buried in the 
description, which is (IMO) not correct.

---
Depending on your application, there may be other types of values (for 
example a mapping app might have directions), a financial app might have 
currencies, etc.)


Note that the "type" may be something your dev team has cobbled up. If 
so, you will need to find the file that they defined the type and then 
locate the definition. (usually with a defType statement)


If you are doing RESTful APIs, check out 
https://gist.github.com/iros/3426278


If you can pick your own tools, then grab a copy of Notepad++, if only 
to use it as a scratch pad.


Once you have all tee information, then you need to work with your PM do 
determine how much reference information you need to provide.  Much of 
this (as always) depends on the target audience.  I've done really basic 
stuff for experts, and full-on "this is what REST is and this is what a 
.yang file looks like" material.  At the very least, you need to provide 
information on how the users (usually developers, but not always), will 
connect to your system, what files are required, what correct out put 
will look line and so on.


That should get you started.


-- Original Message --
From: "Jeff Coatsworth" <jeff.coatswo...@jonasclub.com>
To: "An email list for people using Adobe FrameMaker software." 
<framers@lists.frameusers.com>

Sent: 11/23/2017 7:03:42 AM
Subject: Re: [Framers] OT-Documenting APIs

Write the Docs has a Slack channel and a forum under their umbrella 
(along with an annual conference and meetups all over the world).


-Original Message-
From: Framers 
[mailto:framers-bounces+jeff.coatsworth=jonasclub@lists.frameusers.com] 
On Behalf Of Shmuel Wolfson

Sent: Thursday, November 23, 2017 5:03 AM
To: An email list for people using Adobe FrameMaker software. 
<framers@lists.frameusers.com>; Rick Quatro <r...@rickquatro.com>

Subject: Re: [Framers] OT-Documenting APIs

Are www.writethedocs.org and writethedocs.slack.com the same?


On 22-Nov-17 10:26 PM, Rick Quatro wrote:

Hi Craig,

You might want to check out:

http://www.writethedocs.org/


Rick Quatro
Carmen Publishing Inc.
r...@frameexpert.com
585-366-4017



-Original Message-
From: Framers
[mailto:framers-bounces+rick=rickquatro@lists.frameusers.com] On
Behalf Of A Craig
Sent: Wednesday, November 22, 2017 3:22 PM
To: framers@lists.frameusers.com
Subject: [Framers] OT-Documenting APIs

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:
acr...@shaw.ca <mailto:acr...@shaw.ca>



Alison Craig



___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com

___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com Visit the list's
homepage at  http://www.frameusers.com Archives located at
http://www.mail-archive

Re: [Framers] OT-Documenting APIs

2017-11-23 Thread Jeff Coatsworth 
Write the Docs has a Slack channel and a forum under their umbrella (along with 
an annual conference and meetups all over the world).

-Original Message-
From: Framers 
[mailto:framers-bounces+jeff.coatsworth=jonasclub@lists.frameusers.com] On 
Behalf Of Shmuel Wolfson
Sent: Thursday, November 23, 2017 5:03 AM
To: An email list for people using Adobe FrameMaker software. 
<framers@lists.frameusers.com>; Rick Quatro <r...@rickquatro.com>
Subject: Re: [Framers] OT-Documenting APIs

Are www.writethedocs.org and writethedocs.slack.com the same?


On 22-Nov-17 10:26 PM, Rick Quatro wrote:
> Hi Craig,
>
> You might want to check out:
>
> http://www.writethedocs.org/
>
>
> Rick Quatro
> Carmen Publishing Inc.
> r...@frameexpert.com
> 585-366-4017
>
>
>
> -Original Message-
> From: Framers
> [mailto:framers-bounces+rick=rickquatro@lists.frameusers.com] On 
> Behalf Of A Craig
> Sent: Wednesday, November 22, 2017 3:22 PM
> To: framers@lists.frameusers.com
> Subject: [Framers] OT-Documenting APIs
>
> 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:
> acr...@shaw.ca <mailto:acr...@shaw.ca>
>
>   
>
> Alison Craig
>
>   
>
> ___
>
> This message is from the Framers mailing list
>
> Send messages to framers@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 listad...@frameusers.com
>
> ___
>
> This message is from the Framers mailing list
>
> Send messages to framers@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 listad...@frameusers.com
>

___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com
___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com

Re: [Framers] OT-Documenting APIs

2017-11-23 Thread 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:
acr...@shaw.ca 

  


Alison Craig

  


___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com



___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com

Re: [Framers] OT-Documenting APIs

2017-11-23 Thread Shmuel Wolfson 

Are www.writethedocs.org and writethedocs.slack.com the same?


On 22-Nov-17 10:26 PM, Rick Quatro wrote:

Hi Craig,

You might want to check out:

http://www.writethedocs.org/


Rick Quatro
Carmen Publishing Inc.
r...@frameexpert.com
585-366-4017



-Original Message-
From: Framers
[mailto:framers-bounces+rick=rickquatro@lists.frameusers.com] On Behalf
Of A Craig
Sent: Wednesday, November 22, 2017 3:22 PM
To: framers@lists.frameusers.com
Subject: [Framers] OT-Documenting APIs

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:
acr...@shaw.ca <mailto:acr...@shaw.ca>

  


Alison Craig

  


___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com

___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com



___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com

Re: [Framers] OT-Documenting APIs

2017-11-22 Thread A Craig 
Thanks everyone.

I have a place to start now (more than 1 actually!).

Alison



-Original Message-
From: Framers [mailto:framers-bounces+acraig=shaw...@lists.frameusers.com]
On Behalf Of A Craig
Sent: November 22, 2017 12:22 PM
To: framers@lists.frameusers.com
Subject: [Framers] OT-Documenting APIs

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:
acr...@shaw.ca <mailto:acr...@shaw.ca>  

Alison Craig

 

___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com


___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com

Re: [Framers] OT-Documenting APIs

2017-11-22 Thread Roberta Hennessey 
Tom Johnson of I"d rather we writing blog
http://idratherbewriting.com/
and Peter Gruebaum
http://idratherbewriting.com/2016/02/08/third-api-course-from-peter-gruenbaum/

Peter has 3 courses on Udemy.

On Wed, Nov 22, 2017 at 3: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:
> acr...@shaw.ca 
>
>
>
> Alison Craig
>
>
>
> ___
>
> This message is from the Framers mailing list
>
> Send messages to framers@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 listad...@frameusers.com
>
___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com

Re: [Framers] OT-Documenting APIs

2017-11-22 Thread Robert Lauriston 
You might want to join the techwr-l list and the LinkedIn API
Documentation group. FrameMaker is not a tool that you're likely to
use when documenting APIs.

If you have zero experience with APIs, you might want to take some
programming classes or study it on your own. Python is a good language
to start with regardless and it's a popular language for writing APIs.

Java is probably the most popular but you might want to make it your
second language.
___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com

Re: [Framers] OT-Documenting APIs

2017-11-22 Thread Monique Semp 

Given this fact, I'm wondering if anyone knows of an online course(s) I

could take to how to do [API documentation].

Check out Peter Gruenbaum's classes on Udemy: 
https://www.udemy.com/courses/search/?q=peter%20gruenbaum=ukw (this link 
also shows some that aren't his, but some other person named Peter).


And I 2nd (and 3rd) the suggestion to work through Tom Johnson's tutorials 
on his idratherbewriting site.


And I 2nd (and 3rd) the suggestion to join the Write the Docs Slack network. 
There are channels for all sorts of API- and specific coding 
framework-related tools, techniques, and technologies. The Write the Docs 
website also has a link to its forum/archive somewhere, which is likely to 
have a bunch of helpful getting-started sort of info.


-Monique 


___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com

Re: [Framers] OT-Documenting APIs

2017-11-22 Thread Nadine Murray 
udemy.com
Learn API Technical Writing: JSON and XML for Writers: 
https://www.udemy.com/api-documentation-1-json-and-xml/learn/v4/overview
Learn API Technical Writing 2: REST for Writers: 
https://www.udemy.com/learn-api-technical-writing-2-rest-for-writers/learn/v4/overview



Nadine



  From: Alan Houser <a...@groupwellesley.com>
 To: framers@lists.frameusers.com 
 Sent: Wednesday, November 22, 2017 3:28 PM
 Subject: Re: [Framers] OT-Documenting APIs
   
Another excellent and free resource --

http://idratherbewriting.com/learnapidoc/


On 11/22/17 3: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.
>
>  
>
>


-- 
Alan Houser
Group Wellesley, Inc.
Consultant and Trainer, Technical Publishing
arh on Twitter
412-450-0532

___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com


   
___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com

Re: [Framers] OT-Documenting APIs

2017-11-22 Thread Alan Houser 

Another excellent and free resource --

http://idratherbewriting.com/learnapidoc/


On 11/22/17 3: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.

  






--
Alan Houser
Group Wellesley, Inc.
Consultant and Trainer, Technical Publishing
arh on Twitter
412-450-0532

___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com

Re: [Framers] OT-Documenting APIs

2017-11-22 Thread Rick Quatro 
Hi Craig,

You might want to check out:

http://www.writethedocs.org/


Rick Quatro
Carmen Publishing Inc.
r...@frameexpert.com
585-366-4017



-Original Message-
From: Framers
[mailto:framers-bounces+rick=rickquatro@lists.frameusers.com] On Behalf
Of A Craig
Sent: Wednesday, November 22, 2017 3:22 PM
To: framers@lists.frameusers.com
Subject: [Framers] OT-Documenting APIs

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:
acr...@shaw.ca <mailto:acr...@shaw.ca>  

 

Alison Craig

 

___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com

___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com

Re: [Framers] OT-Documenting APIs

2017-11-22 Thread Jeff Coatsworth 
have you checked the Write the Docs Slack channel? - 
https://writethedocs.slack.com



From: Framers 
<framers-bounces+jeff.coatsworth=jonasclub@lists.frameusers.com> on behalf 
of A Craig <acr...@shaw.ca>
Sent: November 22, 2017 3:22 PM
To: framers@lists.frameusers.com
Subject: [Framers] OT-Documenting APIs

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:
acr...@shaw.ca <mailto:acr...@shaw.ca>



Alison Craig



___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com
___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com

[Framers] OT-Documenting APIs

2017-11-22 Thread A Craig 
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:
acr...@shaw.ca   

 

Alison Craig

 

___

This message is from the Framers mailing list

Send messages to framers@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 listad...@frameusers.com