{"id":1316,"date":"2014-05-23T11:50:22","date_gmt":"2014-05-23T16:50:22","guid":{"rendered":"http:\/\/blografia.net\/vicm3\/?p=1316"},"modified":"2014-05-24T15:36:27","modified_gmt":"2014-05-24T20:36:27","slug":"about-documentation","status":"publish","type":"post","link":"https:\/\/blografia.net\/vicm3\/2014\/05\/about-documentation\/","title":{"rendered":"About documentation"},"content":{"rendered":"

Yesterday as I attended to a talk on OpenMooc<\/a>\u00a0at CUAED<\/a>, on the part of the documentation about it, was mentioned that it’s somewhat outdated and some parts are plain missing as they are a small working group (only four), it came to my mind this nice quote\u00a0\u00ab<\/em><\/strong>Documentation is like sex: when it is good, it is very, very good; and when it is bad, it is better than nothing\u00bb<\/em><\/strong> attributed to Dick Brandon, also I recalled doing a nice collected quotes about this topic for my talk on 2005 about SVN (in Spanish)<\/a>, from that I still like the selection and think its good to complete this post.<\/span><\/p>\n

Programs must be written for people to read, and only incidentally for machines to execute. – H. Abelson and G. Sussman (in \u00abThe Structure and Interpretation of Computer Programs)<\/p>\n

A complex system that works in invariably found to have evolved from a simple system that worked. – J. Gall<\/p>\n

Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live. – M. Golding<\/p>\n

If the code and the comments disagree, then both are probably wrong. – N. Schryer<\/p><\/blockquote>\n","protected":false},"excerpt":{"rendered":"

Yesterday as I attended to a talk on OpenMooc\u00a0at CUAED, on the part of the documentation about it, was mentioned that it’s somewhat outdated and some parts are plain missing as they are a small working group (only four), it … Sigue leyendo →<\/span><\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"advanced_seo_description":"","jetpack_seo_html_title":"","jetpack_seo_noindex":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2},"jetpack_post_was_ever_published":false},"categories":[3,10,8],"tags":[319,322,318,244,320,151,321],"class_list":["post-1316","post","type-post","status-publish","format-standard","hentry","category-general","category-planetalinux","category-sysadmin","tag-consol","tag-cuaed","tag-documentation","tag-mooc","tag-openmooc","tag-svn","tag-talk"],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack-related-posts":[{"id":752,"url":"https:\/\/blografia.net\/vicm3\/2010\/10\/on-the-debian-upgrade-for-moodle-to-1-8-13-miss-profile-pics-i-found-this\/","url_meta":{"origin":1316,"position":0},"title":"Miss the profile pics when upgrading Moodle to 1.8.13 on Debian? I found this","author":"vicm3","date":"12 octubre, 2010","format":false,"excerpt":"On the upgrade from 1.8.2 to 1.8.13 the way \/var\/lib\/moodle profile pics where handle changed in a subtle way. From users\/x to user\/0 user\/1000 user\/2000 this is a very good idea, but I can't find info about it on README.Debian or any other documentation, would be nice to add to\u2026","rel":"","context":"En \u00abEducaci\u00f3n\u00bb","block_context":{"text":"Educaci\u00f3n","link":"https:\/\/blografia.net\/vicm3\/category\/educacion\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":1388,"url":"https:\/\/blografia.net\/vicm3\/2014\/10\/hp-quotes-and-a-pair-of-scenes\/","url_meta":{"origin":1316,"position":1},"title":"HP, quotes and a pair of scenes","author":"vicm3","date":"17 octubre, 2014","format":false,"excerpt":"I really like Harry Potter books, not so much the movies, that say have a lot of quotes that like and a pair or more scenes, I'm posting here to have at hand 'cause it's easier, faster and not need to search on my own svn three. If you want\u2026","rel":"","context":"En \u00abDebraye\u00bb","block_context":{"text":"Debraye","link":"https:\/\/blografia.net\/vicm3\/category\/debraye\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":1425,"url":"https:\/\/blografia.net\/vicm3\/2015\/01\/what-you-tell-about-yourself\/","url_meta":{"origin":1316,"position":2},"title":"What you tell about yourself","author":"vicm3","date":"5 enero, 2015","format":false,"excerpt":"Not talking about yourself. Last year at Debconf Linus Torvalds held a Q&A session and on you can get a really good insight on who is he and what he does from it, I\u2019m posting some excerpts I like about the culture of project correctness at 14:37 I agree that\u2026","rel":"","context":"En \u00abDebraye\u00bb","block_context":{"text":"Debraye","link":"https:\/\/blografia.net\/vicm3\/category\/debraye\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":1378,"url":"https:\/\/blografia.net\/vicm3\/2014\/09\/wordpress-xmlrpc-ddos-mitigation\/","url_meta":{"origin":1316,"position":3},"title":"WordPress xmlrpc DDOS mitigation","author":"vicm3","date":"27 septiembre, 2014","format":false,"excerpt":"Well not long ago DH contacted me with this dreaded message: Hello, I'm writing you about your domain: foo.bar Specifically the file: xmlrpc.php This file is used for modifying your wordpress install from 3rd party\u00a0programs, like mobile site designers, desktop client programs, and pretty\u00a0much anything besides the wordpress control panel\u2026","rel":"","context":"En \u00abplanetalinux\u00bb","block_context":{"text":"planetalinux","link":"https:\/\/blografia.net\/vicm3\/category\/planetalinux\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":232,"url":"https:\/\/blografia.net\/vicm3\/2006\/02\/time_ago\/","url_meta":{"origin":1316,"position":4},"title":"Time ago…","author":"vicm3","date":"6 febrero, 2006","format":false,"excerpt":"In a blog a very good friend I saw a list of advices to childrens, that looks very good... frecuently credited to Bill Gates, I really like the text, but I for a loong time don't believe that Mr. Gates say it... well as I was to post it today,\u2026","rel":"","context":"En \u00abSin categor\u00eda\u00bb","block_context":{"text":"Sin categor\u00eda","link":"https:\/\/blografia.net\/vicm3\/category\/sin-categoria\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":1104,"url":"https:\/\/blografia.net\/vicm3\/2013\/09\/svn-and-its-new-sqlite-format-again\/","url_meta":{"origin":1316,"position":5},"title":"SVN and its new sqlite format again","author":"vicm3","date":"10 septiembre, 2013","format":false,"excerpt":"I been a user of svn for a quite long time now, and had to work around certain \"features\", like berkeley.db locking on multiuser home directories, the migration to FS logs, and problems working with multi platform environments, most of it its documented on this blog. Yeah, git is sexy,\u2026","rel":"","context":"En \u00abDebraye\u00bb","block_context":{"text":"Debraye","link":"https:\/\/blografia.net\/vicm3\/category\/debraye\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]}],"_links":{"self":[{"href":"https:\/\/blografia.net\/vicm3\/wp-json\/wp\/v2\/posts\/1316","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blografia.net\/vicm3\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blografia.net\/vicm3\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blografia.net\/vicm3\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/blografia.net\/vicm3\/wp-json\/wp\/v2\/comments?post=1316"}],"version-history":[{"count":0,"href":"https:\/\/blografia.net\/vicm3\/wp-json\/wp\/v2\/posts\/1316\/revisions"}],"wp:attachment":[{"href":"https:\/\/blografia.net\/vicm3\/wp-json\/wp\/v2\/media?parent=1316"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blografia.net\/vicm3\/wp-json\/wp\/v2\/categories?post=1316"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blografia.net\/vicm3\/wp-json\/wp\/v2\/tags?post=1316"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}