Re: Recommendations for programmer's guides

Subject: Re: Recommendations for programmer's guides
From: Tony Chung <tonyc -at- tonychung -dot- ca>
To: "Marsh, Ed" <Ed -dot- Marsh -at- gs -dot- com>
Date: Mon, 31 Aug 2015 08:45:31 -0700

Hi Ed,

I thought the OP was looking for more a programmer's guide, not an API doc.
There is a major difference between the two, even though the audience is
similar.

API/SDK doc (your specialty) is aimed at developers who have familiarity
with the ecosystem to understand the guts in more depth. It's a reference.

A PG is more for the developer who is getting started, may be branching
from a similar system, or deciding between tools. It's a how-to manual.

A PG would provide best practices for the problem the system solves (and
how the system is meant to be used) and not just a collection of features.

The SDK can add programming guide-like content, but the intent is more for
use as a cookbook than an explanation of the system.

-Tony


On Monday, August 31, 2015, Marsh, Ed <Ed -dot- Marsh -at- gs -dot- com> wrote:

> I don't disagree that Drupal's docs are all over the place (as well as its
> whole ecosystem, but that's another debate), but the API doc section at
> least shows some consistent structure, and I think that's what the OP was
> looking for.
>
> Ed.
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Learn more about Adobe Technical Communication Suite (2015 Release) | http://bit.ly/1FR7zNW

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

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:

References:
Re: Recommendations for programmer's guides: From: Marsh, Ed

Previous by Author: Re: "Software Technical Writing is a Dying Career"
Next by Author: Re: Recommendations for programmer's guides
Previous by Thread: Re: Recommendations for programmer's guides
Next by Thread: RE: Recommendations for programmer's guides


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

Sponsored Ads


Sponsored Ads