[Chicago] Examples of great documentation

[Chris Foresman]

Most docs discuss, sometimes in great detail, the WHAT and the WHERE. Good documentation—which I find to be rare indeed—discuss the HOW and the WHY.


Chris Foresman
chris at chrisforesman.com



> On Oct 22, 2014, at 10:21 AM, Carl Karsten <carl at personnelware.com> wrote:
> 
> 
> On Wed, Oct 22, 2014 at 9:17 AM, Tathagata Dasgupta <tathagatadg at gmail.com <mailto:tathagatadg at gmail.com>> wrote:
> the talk by the twitter guys on their internal tool "Docbird",
> 
> http://videos.writethedocs.org/video/50/techdocs-at-twitter-creating-the-culture-of-docu <http://videos.writethedocs.org/video/50/techdocs-at-twitter-creating-the-culture-of-docu>
> 
> 
> I loved this talk:
> http://videos.writethedocs.org/video/44/documenting-domain-specific-knowledge <http://videos.writethedocs.org/video/44/documenting-domain-specific-knowledge>
> at 17:50 "Sorry, this documentation is not for you."
> 
> 
> I find myself looking up docs for django template filters, and I am always optimistic that it will be this simple:  http://docs.djangoproject.com <http://docs.djangoproject.com/> scroll down to Built-in tags and filters <https://docs.djangoproject.com/en/1.7/ref/templates/builtins/> skim around to figure out if what I am looking for exists and how to use it.  Almost always it only takes me a min or two.    
> 
> 
> 
> -- 
> Carl K
> _______________________________________________
> Chicago mailing list
> Chicago at python.org
> https://mail.python.org/mailman/listinfo/chicago

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/chicago/attachments/20141022/6bfe860b/attachment.html>