Comprendre el flux de treball amb Penflip
5 minuts de lecturaPenflip és una plataforma web d'escriptura col·laborativa creada per Loren Burton similar a GitHub però orientada al text enlloc d'al codi. Penflip recull la filosofia de treball del sistema de control de versions de Git però aplicada a la redacció distribuïda de documentació. Aquesta guia explica com funciona el flux de treball amb Penflip. La guia és una adaptació de la guia del flux de treball de GitHub.
Treballar amb còpies
En el moment d'anar desenvolupant el contingut del miniop és habitual pensar en diferents propostes i idees, algunes d'aquestes es mantindran al llarg del procés i d'altres s'acabaran descartant. El sistema de còpies us ajudarà a gestionar aquest flux de treball.
Quan creeu una còpia (Make Changes) del document màster esteu creant un entorn on podreu recollir aquest conjunt d'idees i propostes. Els canvis i les modificacions que realitzeu no afectaran el màster i, per tant, us proporciona la seguretat de que aquestes modificacions es fan en un terreny segur i que no s'incorporaran al màster fins que no siguin revisades i aprovades per l'equip de miniops.
Recordeu que per visualitzar la còpia del document cal que, des de l'espai de projectes (Dashboard), canvieu l'opció Started by | Me a Started by | Others com us mostra la següent captura de pantalla:
Exemple pràctic
L'equip dels miniops crea el document base i defineix l'estructura bàsica del miniop. Aquest document s'anomenarà màster. Només l'equip dels miniops pot editar-lo.
La Begonya, com a responsable del grup de treball d'un miniop, crea una còpia del document màster i, per tant, té la seva versió. No ha hagut de baixar cap fitxer. Penflip gestiona aquest procés. La Begonya pot fer canvis sense preocupar-se si aquestes modificacions afecten el document màster. Afegeix el contingut d'un parell de seccions i aprofita per corregir el títol d'un pas.
Desar els canvis
Una vegada hàgiu creat la còpia del Màster és el moment de fer els canvis. Quan modifiqueu, afegiu o esborreu i, posteriorment, deseu qualsevol cosa, esteu creant una instantània del document-còpia en el procés de treball. Aquestes instantànies permeten tenir un registre de tot el que heu realitzat i, si escau, recuperar instantànies anteriors.
Aquestes instantànies formen l'històric del treball que realitzeu i, per tant, permet a altres veure, de manera transparent, l'evolució del document. Cada instantània té associat un missatge que és, en definitiva, una breu descripció de les modificacions que heu realitzat.
Exemple pràctic
La Begonya va desant els canvis a mesura que treballa amb la seva còpia
Enviar el canvis
Quan envieu els canvis iniciareu un debat sobre les modificacions que heu realitzat. És el moment en què l'equip de miniops determinarà o no si aquests canvis s'integren o no al document màster.
Podeu enviar els canvis en qualsevol moment del procés: quan heu incorporat el contingut d'un nou pas; quan esteu estancats amb la redacció d'un pas; quan proposeu una infografia, una imatge o una idea o, finalment, si necessiteu una revisió general del document.
Exemple pràctic
La Begonya pensa que els canvis són suficients per introduir-los al document màster i, per aquest motiu, clica al botó Submit changes. L'equip dels miniops rep la petició de la Begonya. En aquest moment, l'equip fa una revisió dels canvis entre el document màster i la còpia editada de la Begonya amb els comentaris inclosos.
Revisió i debat dels canvis
Un cop que s'envien els canvis realitzats perquè siguin inclosos al document màster comença el procés de revisió. Durant aquest procés de revisió hi pot haver qüestions, dubtes o comentaris sobre les modificacions que es volen incorporar al document màster.
Durant aquest procés de revisió i debat podeu fer canvis i modificacions del contingut del document còpia per tornar a enviar els nous canvis (Submit changes).
Exemple pràctic
La Catina detecta diverses incidències d'estil o de contingut i, per aquest motiu, n'informa la Begonya mitjançant un comentari contextual. La Begonya corregeix les errades i envia de nou la petició d'actualització del document màster. L'equip rep la nova petició i l'aprova.
Integració dels canvis al màster
Una vegada que els canvis proposats han estat revisats i acceptats, es procedeix a introduir-los al document màster. En aquest moment el màster s'actualitza i, per tant, tots els documents-còpia del màster notificaran l'actualització del màster i la necessitat de treballar amb una còpia actualitzada abans de ser editats.
Exemple pràctic
Finalment els canvis fets per la Begonya s'incorporen al màster. En aquest moment la còpia del document de la Begonya i el màster són idèntics. La Begonya pot continuar treballant en la còpia i començar de nou el cicle de treball descrit en aquesta guia.
Última actualització: 7 d'Octubre, 2014