TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Doc-To-Help 2014 v1 now available. SharePoint 2013 support, NetHelp enhancements, and more. Read all about it.
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