Quando scegli un titolo per un nuovo numero, ci sono diverse opzioni grammaticali tra cui scegliere. Ecco quattro diverse opzioni per un problema di esempio appena creato:
- Descrittivo : "Le nuove righe non vengono eliminate quando vengono analizzate le intestazioni di più righe"
- Imperativo - negativo : "Evita di lasciare righe nuove durante l'analisi di intestazioni su più righe"
- Imperativo - primo contesto : "Correzione dell'errore di intestazioni su più righe: striscia di nuove righe"
- Imperativo: prima l'azione desiderata : "Elimina righe nuove durante l'analisi di intestazioni multi-linea"
Sul mio posto di lavoro i titoli dei problemi si alternano tra tutti questi formati, ma continuo a pensare che sia meglio scegliere una convenzione e attenerci ad essa.
Quale opzione (da quella precedente o un'altra) è quella preferita, ovvero quella che ridurrà al minimo lo sforzo degli sviluppatori di leggere questi problemi?
Modifica: come indicato nei commenti, diversi tipi di problemi possono giustificare una scelta diversa della grammatica, in cui una distinzione particolarmente importante è tra bug e nuove opere. Per rendere la domanda più specifica, supponiamo di scegliere, poiché msell offre in la sua risposta , l'opzione descrittiva. Ora diamo un'occhiata a un suggerimento per migliorare una funzione esistente:
- "Aggiungi informazioni sulla città alla geolocalizzazione"
Se ci atteniamo alla grammatica descrittiva, dovremmo sostituire quel titolo con
- "Informazioni sulla città mancanti dalla geolocalizzazione"
Tuttavia, questo sembra meno chiaro, poiché la mancanza di informazioni sulla città non è un bug, è il comportamento previsto. Il giornalista sta semplicemente suggerendo di migliorare quel comportamento. Quindi sembra che l'opzione imperativa sia la via da seguire per quel problema.
Diamo un'occhiata ora a una funzionalità completamente nuova. Considera queste opzioni:
- "Nessuna possibilità di esportare report in XML"
- "Aggiungi la possibilità di esportare un rapporto in XML"
- "Esporta report in XML"
Descrivere il comportamento attuale sembra ancora più ridicolo qui, ma l'opzione imperativa non sembra così buona. La terza opzione descrive semplicemente la nuova funzione stessa, che potrebbe essere la via da seguire, supponendo che il problema abbia metadati che indicano che si tratta di un problema di "nuova funzionalità".
- Quindi cosa è più importante: attenersi a una convenzione o abbinare la grammatica al problema?
- Dove tracciare la linea tra un titolo descrittivo e un titolo imperativo?
- Quando descriveresti il comportamento corrente e il comportamento desiderato?