tips for API documentation

Subject: tips for API documentation
From: Monica Cellio <cellio -at- pobox -dot- com>
To: "'techwr-l -at- lists -dot- techwr-l -dot- com'" <techwr-l -at- techwr-l -dot- com>
Date: Wed, 26 Mar 2014 16:08:27 +0000 (UTC)

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 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


Follow-Ups:

Previous by Author: Re: Ribbon menu nomenclature
Next by Author: Re: Digits separator
Previous by Thread: Ben Barone-Nugent has a good post on writing for users
Next by Thread: Re: tips for API documentation


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

Sponsored Ads


Sponsored Ads