Documentare con Read the Docs

readthedocs

Ho sempre pensato che una delle azioni più importanti dell’insegnante sia quella del documentare l’azione didattica. Mi è capitato spessissimo incontrare in questi anni colleghi bravissimi che avevano escogitato tecniche didattiche o realizzato appunti personali che potevano essere sostituiti ai libri di testo, perché questi erano diventati gli argomenti di reale necessità dell’allievo, appunti che nel tempo si arricchivano delle esperienze di altri. Il peggio arriva quando giunti alla pensione molti portano con se appunti ed esperienza ed ogni cosa cade nell’oblio… nessuna documentazione nessuna esperienza tramandata…

Ma come documentare in modo agevole, elegante, usabile, veloce?

Non so darvi la giusta soluzione, certo è che i primi due passi in ogni azione lavorativa, sono:

  1. progettare il modo di documentare;
  2. documentare;

fatto ciò gli anni di lavoro che verranno saranno più semplici.

Le soluzioni possono essere tantissime, da un semplice blog in WordPress come questo, ad un Wiki, oppure, anche se un po’ più complicato usando un sistema di revisioning che conserva anche lo storico di tutte le modifiche effettuate.

Un po’ per curiosità ed un po’ per necessità sto analizzando Read the Docs, un servizio gratuito che vi permette di creare e ospitare la vostra documentazione, in modo che l’azione del costruire e ricercare sia molto semplice.
Potete importare i vostri documenti utilizzando qualsiasi sistema di controllo di versione inclusi: Mercurial, Git, Subversion e Bazaar. Supporta i webhooks ed è inoltre possibile avere anche un controllo sulla versione.

Vedremo se questa sarà la soluzione, in ogni caso il messaggio ai miei studenti è: “sforzarsi il più possibile di rendere l’azione del documentare un azione costante, un’abitudine, una fase necessaria proprio lavoro“.

Articoli simili:

Questa voce è stata pubblicata in tutorial e contrassegnata con , , , , , . Contrassegna il permalink.

Lascia un commento

Il tuo indirizzo email non sarà pubblicato. I campi obbligatori sono contrassegnati *

Questo sito usa Akismet per ridurre lo spam. Scopri come i tuoi dati vengono elaborati.