Re: Recommendations for programmer's guides

Subject: Re: Recommendations for programmer's guides
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>
Date: Mon, 31 Aug 2015 08:39:16 -0700

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

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

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:
Re: Recommendations for programmer's guides: From: Marsh, Ed

Previous by Author: Re: Recommendations for programmer's guides
Next by Author: RE: Business Glossary
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