About documentation

Yesterday as I attended to a talk on OpenMooc at 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 came to my mind this nice quote Documentation is like sex: when it is good, it is very, very good; and when it is bad, it is better than nothing” attributed to Dick Brandon, also I recalled doing a nice collected quotes about this topic for my talk on 2005 about SVN (in Spanish), from that I still like the selection and think its good to complete this post.

Programs must be written for people to read, and only incidentally for machines to execute. – H. Abelson and G. Sussman (in “The Structure and Interpretation of Computer Programs)

A complex system that works in invariably found to have evolved from a simple system that worked. – J. Gall

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

If the code and the comments disagree, then both are probably wrong. – N. Schryer

Esta entrada fue publicada en General, planetalinux, sysadmin y etiquetada , , , , , , . Guarda el enlace permanente.

Deja un comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

Este sitio usa Akismet para reducir el spam. Aprende cómo se procesan los datos de tus comentarios.