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.
The original post says "programmer's guide" with no mention of an API.
API docs, the first and most important task is is to figure out how to
generate them from source code.
On Mon, Aug 31, 2015 at 6:48 AM, 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.
> ------------------------------
> Message: 3
> Date: Sat, 29 Aug 2015 11:57:29 -0700
> From: Robert Lauriston <robert -at- lauriston -dot- com>
> To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
> Subject: Re: Recommendations for programmer's guides
> Message-ID:
> <CAN3Yy4BdXqqHKJLFoCu9REDN4z8GtKFL2GfgZYxdFQ3_qwX38Q -at- mail -dot- gmail -dot- com>
> Content-Type: text/plain; charset=UTF-8
>
> I found Drupal's documentation pretty terrible when I tried to use it to learn how to build a site. There were introductory docs that described the various components of the system, and advanced docs for experienced developers, but no solid sample project to bridge the gap between the two.
>
> Not to single Drupal out for criticism, that's a very common problem with developer docs.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Learn more about Adobe Technical Communication Suite (2015 Release) | http://bit.ly/1FR7zNW
