«Training time and cost are reduced: No longer do new team members have to learn about your organization via osmosis. Through great documentation, a new hire is able to quickly learn about your internal processes and your customer environments. Less time is taken up trying to get them up to speed on how things are done because it is all there for them to see, and important information is easily accessible rather than stored in the repository of someone’s mind. - Documentation is the Key to Your Success»
Y sí, una actividad que resultaba ser bastante aburrida, fue más agradable cuando pude automatizarla; eso sí, los beneficios siempre serán visibles en el mediano y largo plazo.
La implementación que realicé sobre VIM es bastante sencilla, usando un plugin y tres variables de entorno; me permite adjuntar de manera automática headers sobre scripts de ruby, bash, js y python; estoy seguro que con algo más de trabajo se puede hacer algo más interesante.
Lo primero, acorde a la documentación es necesario colocar el plugin en el directorio [~/vim/plugin]:
USING A GLOBAL PLUGIN
First read the text in the plugin itself to check for any special conditions.
Then copy the file to your plugin directory:
system plugin directory
Unix ~/.vim/plugin/
PC and OS/2 $HOME/vimfiles/plugin or $VIM/vimfiles/plugin
Amiga s:vimfiles/plugin
Macintosh $VIM:vimfiles:plugin
Mac OS X ~/.vim/plugin/
RISC-OS Choices:vimfiles.plugin
Example for Unix (assuming you didn't have a plugin directory yet):
mkdir ~/.vim
mkdir ~/.vim/plugin
cp /tmp/yourplugin.vim ~/.vim/plugin
That's all! Now you can use the commands defined in this plugin.
Tomar el código que dispuse en Gist:GitHUB
Y pegarlo en el directorio mencionado, nada como el demo para tener idea de cómo funciona:
Referencias: