Il commento in una revisione del codice sta gestendo
Tratta i commenti come uno strumento di gestione
L'inserimento di commenti in una revisione del codice è una forma di gestione. Come tale, dovrebbe essere affrontato come uno strumento di gestione.
Usa le pratiche manageriali per commentare
Esiste una struttura per la gestione delle persone in cui l'obiettivo è raggiungere il risultato desiderato. Alcuni dei principali approcci alla gestione non si applicheranno nei commenti, ma la maggior parte lo farà. Gli argomenti applicabili includono ambiente, leadership, organizzazione e controllo.
Ambiente
Cultura
L'ambiente determina lo stile di gestione. La cultura e l'ambiente del luogo di lavoro dovrebbero essere tenuti presenti quando si utilizzano strumenti di gestione. Di solito questo è influenzato dal settore e dalle dimensioni dell'azienda o entità gestita.
Stile
Se esiste una cultura spensierata, ciò può manifestarsi nello stile di gestione utilizzato. Se ci sono linee guida, politiche e conseguenze molto rigide, ciò dovrebbe riflettersi nello stile utilizzato. Quindi, se tutti sono a bordo per una battuta di guerre stellari che fa riferimento a droidi e uno stormtrooper di mentalità debole, allora potrebbe essere applicabile un'interiezione comica. Tuttavia, se ci sono conseguenze disastrose nel non prendere sul serio il risultato finale, potrebbe essere necessario evitarlo.
Comando
fondamenti
Ci sono tre pilastri principali della leadership da considerare quando si commenta. Vale a dire che sono visione, comunicazione e giudizio.
Vision
È importante quando tenere a mente la grande visione quando si spiega o si danno istruzioni. Nei commenti, ciò potrebbe significare sottolineare come piccoli cambiamenti influenzano il progetto nel suo insieme, quali sono le implicazioni di adottare approcci diversi o un suggerimento per la separazione delle preoccupazioni.
Communication
Essere un buon comunicatore è importante in molti aspetti della vita. Non è diverso nei commenti. Impiegare un saggio livello di brevità è importante, soprattutto perché i commenti non dovrebbero occupare molto spazio. Arrivare al punto in anticipo, quindi eseguirne il backup con un esempio, se necessario. In un'organizzazione più grande, ciò può includere anche la necessità di inviare un comunicato o un promemoria se il problema non è localizzato in una sessione di revisione.
Judgement
È importante che la strategia venga utilizzata per valutare se è necessario formulare commenti e quali modifiche devono essere apportate. Il tuo giudizio non deve sempre essere corretto, ma deve essere costantemente corretto, specialmente quando vengono fatte grandi richieste di giudizio.
organizzazione
Da un punto di vista gestionale, l'organizzazione farà riferimento a tenere presente l'obiettivo finale e garantire che i processi siano allineati per seguire un insieme di regole. I commenti dovrebbero anche tenere presente ciò in quanto i commenti dovrebbero, quando possibile, basarsi l'uno sull'altro per assicurarsi che il flusso del design sia seguito. Sarà inoltre importante tenere presente l'ambito del codice in esame al fine di ridurre l'accoppiamento e seguire il progetto generale.
Controllo
Il controllo delle azioni di coloro che sono gestiti è un processo delicato. Pur essendo fermi, va anche tenuto presente che le persone sono importanti. Esistono diverse abilità manageriali da utilizzare mentre si controllano gli altri. Queste abilità sono politiche, concettuali, interpersonali, diagnostiche e tecniche.
Politico
La politica può essere trovata ogni volta che c'è interazione tra le persone. È un argomento enorme, ma in senso generale la politica ruota attorno all'influenza. È importante tenere presente la politica personale e professionale al lavoro quando si fa un commento. Ciò potrebbe essere correlato a un'istruzione, a uno scherzo o persino a una domanda.
Concettuale
La gestione attraverso la concettualizzazione è uno strumento importante. Richiede un'analisi complessa della situazione attuale. Nel commentare può essere utile includere alcune delle analisi utilizzate per giungere alla conclusione o alla modifica indicate nella recensione.
interpersonale
Le abilità interpersonali sono molto importanti nella gestione. Anche questo è un argomento di grandi dimensioni. Alcune delle cose importanti da considerare con le capacità interpersonali sono il tutoraggio, le critiche costruttive e la "arpionatura".
Mentoring
È importante che il management sia visto più come un mentore che come un antagonista. In una revisione del codice, ciò significa che a volte sarà utile includere un cenno a un modello o approccio di progettazione che potrebbe essere utilizzato per migliorare una situazione.
Constructive Criticism
La critica è importante perché invoca la riflessione. Tuttavia, le critiche dovrebbero essere mantenute il più positive possibile quando possibile. Ciò significa offrire prove valide a sostegno delle critiche e anche garantire che il tono usato non sia negativo. Quando si rivede il codice, ciò potrebbe includere la visualizzazione di un'eccezione o uno scenario possibile che genererebbe un errore, implicando una soluzione invece di mostrare ogni luogo che era errato quando l'intero pezzo di codice avrebbe dovuto essere comunque sostituito.
"Harpooning"
"Arpionamento" è quando arpionicamente figurato qualcuno a terra. Questo viene fatto abbattendoli passo dopo passo senza alcun recupero fino al punto in cui si sentono incapaci di alzarsi. Se arponi una persona in una revisione del codice o altrove perderai la loro collaborazione. È importante evitare di abbattere eccessivamente qualcuno.
Sintesi
Tratta i commenti in una revisione del codice come uno strumento gestionale. Tieni presente che i commenti dovrebbero essere brevi, pertinenti e costruttivi. Assicurarsi inoltre che durante il commento la persona sottoposta a revisione sia presa in considerazione.