Re: tips for API documentation

Subject: Re: tips for API documentation
From: Lois Patterson <loisrpatterson -at- gmail -dot- com>
To: Monica Cellio <cellio -at- pobox -dot- com>
Date: Wed, 26 Mar 2014 12:34:46 -0700

Thanks Monica! I, for one, appreciate it, along with Sarah Maddox's blog:
ffeathers.wordpress.com .

I am giving a talk on API documentation at Write the Docs in May.

http://conf.writethedocs.org/na/2014/index.html


Lois Patterson


On Wed, Mar 26, 2014 at 9:08 AM, Monica Cellio <cellio -at- pobox -dot- com> wrote:

> I wrote an article on Stack Exchange (a family of Q&A sites; this one is
> about writing) about writing better API reference documentation (like
> Javadoc). I thought folks here might be interested, so at the risk of
> self-promotion, here's the link:
>
> http://writers.stackexchange.com/q/10501/1993
>
> Monica
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Doc-To-Help 2014 v1 now available. SharePoint 2013 support, NetHelp
> enhancements, and more. Read all about it.
>
> Learn more: http://bit.ly/NNcWqS
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as loisrpatterson -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
> http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Doc-To-Help 2014 v1 now available. SharePoint 2013 support, NetHelp enhancements, and more. Read all about it.

Learn more: http://bit.ly/NNcWqS

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


References:
tips for API documentation: From: Monica Cellio

Previous by Author: Two things that are exciting for this tech writer
Next by Author: Visio images are printing blurry in Bluebeam
Previous by Thread: tips for API documentation
Next by Thread: "Break Grammar Rules on Websites for Clarity"


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads