<html><head><style>body{font-family:Helvetica,Arial;font-size:13px}</style></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;"><div id="bloop_customfont" style="font-family:Helvetica,Arial;font-size:13px; color: rgba(0,0,0,1.0); margin: 0px; line-height: auto;">I may be burning myself saying this:</div><div id="bloop_customfont" style="font-family:Helvetica,Arial;font-size:13px; color: rgba(0,0,0,1.0); margin: 0px; line-height: auto;"><br></div><div id="bloop_customfont" style="font-family:Helvetica,Arial;font-size:13px; color: rgba(0,0,0,1.0); margin: 0px; line-height: auto;">The Ruby on Rails documentation (specifically, their guides: <a href="http://guides.rubyonrails.org/">http://guides.rubyonrails.org/</a>) are beautifully detailed.</div><div id="bloop_customfont" style="font-family:Helvetica,Arial;font-size:13px; color: rgba(0,0,0,1.0); margin: 0px; line-height: auto;"><br></div><div id="bloop_customfont" style="font-family:Helvetica,Arial;font-size:13px; color: rgba(0,0,0,1.0); margin: 0px; line-height: auto;">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.</div><div id="bloop_customfont" style="font-family:Helvetica,Arial;font-size:13px; color: rgba(0,0,0,1.0); margin: 0px; line-height: auto;"><br></div><div id="bloop_sign_1413987792708386816" class="bloop_sign"><div><font face="Menlo" size="1">{<br> "name": "Hector Rios",<br> "title": "Software Developer",<br> "contact": {<br> "linkedin": "hrios10",<br> "gmail": “labeledloser”,</font></div><div><span style="font-family: Menlo; font-size: x-small;"> </span><font face="Menlo" size="1"> “site”: “http://hectron.github.io/"<span class="Apple-tab-span" style="white-space:pre"> </span> <br> }<br>}<br></font><div><font face="Menlo" size="1"><br><span style="color: rgb(204, 204, 204);"><font>No trees were killed to send this message, but a large number of electrons were terribly inconvenienced.</font></span></font></div></div></div> <br><p style="color:#000;">On October 22, 2014 at 9:18:08 AM, Tathagata Dasgupta (<a href="mailto:tathagatadg@gmail.com">tathagatadg@gmail.com</a>) wrote:</p> <blockquote type="cite" class="clean_bq"><span><div><div></div><div>
<title></title>
While most of the talks are great, of specific mention
are <a href="http://youtu.be/jr7AUb0_bto">http://youtu.be/jr7AUb0_bto</a> (
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.<br>
<br>
On Wednesday, October 22, 2014, sheila miguez <<a href="mailto:shekay@pobox.com">shekay@pobox.com</a>> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div dir="ltr">
<div class="gmail_extra"><br>
<div class="gmail_quote">On Wed, Oct 22, 2014 at 8:36 AM, Jason
Wirth <span dir="ltr"><<a href="javascript:_e(%7B%7D,'cvml','wirth.jason@gmail.com');" target="_blank">wirth.jason@gmail.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<div>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? </div>
</blockquote>
</div>
<br></div>
<div class="gmail_extra">Stripe has beautiful api documentation. It
is easy to read, they provide examples in multiple languages, and
the navigation is easy to use.<br>
<br>
<a href="https://stripe.com/docs/api" target="_blank">https://stripe.com/docs/api</a><br>
<br></div>
<div class="gmail_extra">I bookmarked them as an example to live up
to while I was writing api docs.<br>
<br></div>
<div class="gmail_extra">I've not needed to write any stripe
client, so I don't know how good the rest of the docs are. <a href="https://stripe.com/docs" target="_blank">https://stripe.com/docs</a><br>
<br></div>
<div class="gmail_extra">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.<br>
<br></div>
<div class="gmail_extra">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.<br>
<br></div>
<div class="gmail_extra">I'm very opinionated about the topic. I
could go on and on.<br>
<br></div>
<div class="gmail_extra">There's a conference about this that Carl
has recorded.<br>
<br>
<a href="http://conf.writethedocs.org/" target="_blank">http://conf.writethedocs.org/</a><br>
<br></div>
<div class="gmail_extra">We host the videos on the rackspace
pyvideo account, unless the wtd folks have taken it over on their
own system.<br></div>
<div class="gmail_extra"><br></div>
<div class="gmail_extra"><br clear="all">
<br>
--<br>
<div dir="ltr"><a href="javascript:_e(%7B%7D,'cvml','shekay@pobox.com');" target="_blank">shekay@pobox.com</a></div>
</div>
</div>
</blockquote>
<br>
<br>
--<br>
<div dir="ltr">Cheers,
<div>T
<div><br></div>
<div>
<div>Sent from my iPhone<br></div>
</div>
</div>
</div>
<br>
_______________________________________________
<br>Chicago mailing list
<br>Chicago@python.org
<br>https://mail.python.org/mailman/listinfo/chicago
<br></div></div></span></blockquote></body></html>