Aquest és un experiment per veure que tal se’ns dona documentar en reStructuredText. Anteriorment, ens ha costat molt crear una base de dades de coneixement compartit, preferint altres formes més personals de documentació.
Veiam que tal va!
Per ara comencem amb quatre categories:
- Procediments i bones pràctiques d’equip
- Tips and Tricks
- How To
- Troubleshooting
Per cada nova entrada cal crear un fitxer .rst al directori corresponent. Després pujar els canvis a GitHub. Els canvis es compilen i es pugen directament al repositori de readthedocs.org en aquesta URL:
http://upcnet-gc-docs.readthedocs.org/
Documents que contenen recomanacions i bones pràctiques que hem d’observar sempre que poguem. Són importants ja que si tots mirem d’aplicar-los revertirà en un augment de qualitat en el nostre treball diari.
Accions que proporcionen Big Wins (TM) al nostre treball diari. Aquelles que un cop les apliquem, se’ns queda un somriure a la boca i internament pensem (Muahahaha)
Documents que expliquen un aspecte o funcionalitat concreta.