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++
"Shmuel Wolfson"
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/co
orrect out put
will look line and so on.
That should get you started.
-- Original Message --
From: "Jeff Coatsworth"
To: "An email list for people using Adobe FrameMaker software."
Sent: 11/23/2017 7:03:42 AM
Subject: Re: [Framers] OT-Documenting APIs
Write th
, November 23, 2017 5:03 AM
To: An email list for people using Adobe FrameMaker software.
; Rick Quatro
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
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
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
[mailt
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-Docume
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 h
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
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&src=ukw (this link
also shows some that aren't his, but some other person
From: Alan Houser
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 becaus
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)
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 2
have you checked the Write the Docs Slack channel? -
https://writethedocs.slack.com
From: Framers
on behalf
of A Craig
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
14 matches
Mail list logo
