Re: Recommendations for programmer's guides

Subject: Re: Recommendations for programmer's guides
From: "Marsh, Ed" <Ed -dot- Marsh -at- gs -dot- com>
To: "'techwr-l -at- lists -dot- techwr-l -dot- com'" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 28 Aug 2015 12:30:12 -0400

Check out Drupal's API documentation for a good example:
https://api.drupal.org/api/drupal

You may also want to check out github.com and search for documentation; it's a huge repository of active, open-source projects.

Ed Marsh

----------------------------------------------------------------------

Message: 1
Date: Tue, 25 Aug 2015 09:42:56 +0000
From: Teddie H <teddiehmb -at- hotmail -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Subject: Recommendations for programmer's guides
Message-ID: <DUB114-W551D2F1A6D3E5CCE5DB09EB5610 -at- phx -dot- gbl>
Content-Type: text/plain; charset="iso-8859-1"

Hi all,

Either writing programmer's guides is as much a dying art as tech authoring is rumoured to be, or my query is too daft to answer - but I got no responses to my original plea for help, so I'm displaying my capacity for audacity by reposting.


----------------------------------------------------------------------


I have not worked on programmer's guides but now have the opportunity to do so. The initial draft I have seen looks rather sparse and not the best structure. Please can anyone recommend a decent example of a programmer's guide that I can look at for comparison?

I particularly need to know what the range of contents might need to be, as well as structure. We have format templates to use/adapt.

If the example contains or is accompanied by a Reference Design, that would be even better.

Many thanks for your help (pretty please?),

Heidi
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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:

Previous by Author: Re: manual vs white paper
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