[Chicago] Examples of great documentation

[Hector Rios]

I may be burning myself saying this:

The Ruby on Rails documentation (specifically, their guides: http://guides.rubyonrails.org/) are beautifully detailed.

There have been numerous times when I hopped onto IRC to get help, but as a last check prior to asking — I checked the guides only to find the answer I was looking for.

{
    "name": "Hector Rios",
    "title": "Software Developer",
    "contact": {
            "linkedin": "hrios10",
            "gmail": “labeledloser”,
            “site”: “http://hectron.github.io/"	  
    }
}

No trees were killed to send this message, but a large number of electrons were terribly inconvenienced.

On October 22, 2014 at 9:18:08 AM, Tathagata Dasgupta (tathagatadg at gmail.com) wrote:

While most of the talks are great, of specific mention are http://youtu.be/jr7AUb0_bto ( Instrumentation as Living Documentation) and the talk by the twitter guys on their internal tool "Docbird", addressing the concerns that docs get stale faster than code and having multiple sources of truth all across your dev artifacts.

On Wednesday, October 22, 2014, sheila miguez <shekay at pobox.com> wrote:

On Wed, Oct 22, 2014 at 8:36 AM, Jason Wirth <wirth.jason at gmail.com> wrote:
I'm curious if people have examples of great documentation. The more specific the better; rather than saying "The Django documentation", is there a particular section that stands out? 

Stripe has beautiful api documentation. It is easy to read, they provide examples in multiple languages, and the navigation is easy to use.

https://stripe.com/docs/api

I bookmarked them as an example to live up to while I was writing api docs.

I've not needed to write any stripe client, so I don't know how good the rest of the docs are. https://stripe.com/docs

I was using google's api docs for youtube last night. I hate how much I had to switch context to find what I was looking for. But, I do like how they provide interactive examples.

Re django docs. I hate them. It is hard to remember how to navigate to what I want. I end up googling key words in the docs to find what I want.

I'm very opinionated about the topic. I could go on and on.

There's a conference about this that Carl has recorded.

http://conf.writethedocs.org/

We host the videos on the rackspace pyvideo account, unless the wtd folks have taken it over on their own system.



--
shekay at pobox.com


--
Cheers, 
T 

Sent from my iPhone

_______________________________________________  
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/20110d29/attachment.html>