Re: "You are what you document" - blog post

Subject: Re: "You are what you document" - blog post
From: David Farbey <dfarbey -at- yahoo -dot- co -dot- uk>
To: techwr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 13 Jun 2014 08:10:06 +0100

Thanks for sharing the link, the article is a very good review of best
practices for developer-facing code project documentation.

The idea of "readme driven development" is intriguing, and could be useful.
I was once on a project where we tried to write the user guide before any
code was written, so that the developers would know what they were aiming
to create. It didn't end well. YMMV.

David

David Farbey - david -at- farbey -dot- co -dot- uk
Mobile 07538 420 800
http://about.me/davidfarbey



On 12 June 2014 18:06, Lois Patterson <loisrpatterson -at- gmail -dot- com> wrote:

> I saw this posted on Twitter yesterday, and I found it an excellent summary
> for the hows and whys of documentation.
>
> http://brikis98.blogspot.ca/2014/05/you-are-what-you-document.html?m=1
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Doc-To-Help 2014 v1 now available. SharePoint 2013 support, NetHelp
> enhancements, and more. Read all about it.
>
> Learn more: http://bit.ly/NNcWqS
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as dfarbey -at- yahoo -dot- co -dot- uk -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
>


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Doc-To-Help 2014 v1 now available. SharePoint 2013 support, NetHelp enhancements, and more. Read all about it.

Learn more: http://bit.ly/NNcWqS

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

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:
"You are what you document" - blog post: From: Lois Patterson

Previous by Author: RE: Quoting copyrighted material in a tech manual?
Next by Author: Re: Authoring Tool for Online Help
Previous by Thread: "You are what you document" - blog post
Next by Thread: RE: "You are what you document" - blog post


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

Sponsored Ads


Sponsored Ads