Come si mantengono le e-mail brevi ma complete? [chiuso]

Sono lo strano tipo di sviluppatore a cui piace scrivere e spiegare - e-mail, specifiche, il nome. Mi piace aiutare le persone a capire le cose in profondità. Odio le comunicazioni di ping-pong in cui i gruppi passano attraverso 30 o 40 e-mail, telefonate e riunioni perché il 25% del gruppo ha frainteso la precedente e-mail tratteggiata in cui lo scrittore ha solo spiegato a metà la sua posizione, o aveva fretta e ha sbagliato a scrivere una parola critica o lasciato fuori un negativo o due.

Questo tratto è ottimo per la documentazione, ma le mie e-mail sono lunghe, quindi le persone semplicemente non le leggono. Un paio di strategie che ho usato sono la formattazione di lunghe e-mail come documenti Word allegati per incoraggiare le persone a visualizzarle come documentazione (a volte funziona sorprendentemente bene), o cercando di utilizzare più punti elenco anziché paragrafi gratuiti. Queste strategie aumentano il numero di lettori, ma il contenuto è ancora lungo.

Ovviamente voglio urlare e gridare che argomenti tecnici complessi richiedono molta esposizione e chiarimenti, ma ciò non aiuta nessuno. Ovviamente ci sono dei compromessi che possono essere fatti, ma ho difficoltà a giustificare fare dichiarazioni che non sono chiare o che porteranno a un milione di domande, incomprensioni o aggiunti "termini e condizioni" in seguito.

Come si mantengono le comunicazioni brevi ma complete?

Sintesi:

Metti i fatti importanti in alto quindi espandi in basso.

Dettagli:

Quando ho una lunga e-mail tecnica che temo perderà la metà del pubblico, faccio uno sforzo per mettere un breve "sommario esecutivo" in alto e includere i dettagli tecnici completi di seguito. Anche l'uso selettivo di grassetto o sottolineatura aiuta.

Concentrati su ciò che stai cercando di comunicare. Non ogni parola che hai usato aiuto il vostro messaggio?

Cerca di evitare aggettivi . Evitare ranting o spiegazioni eccessive. Usa la frase più concisa possibile - non cercare di sembrare impressionante usando parole lunghe e frasi complesse in cui esiste un'opzione più semplice. Evita le parole segrete.

Leggi " On Writing " di Stephen King.

Uso meno parole, il che sembra fare abbastanza bene il lavoro.

seriamente, però ...

Prova solo a spiegare le cose pertinenti, ad esempio "carica un file" invece di entrare nei dettagli su COME caricare il file e controllare gli errori mentre lo fai, ecc. Ecc.

• Ovunque sia possibile, collegare a un riferimento esistente quando è necessaria una lunga spiegazione, anziché includere l'intera spiegazione nell'e-mail.
• Pensa a cosa il destinatario vuole fare con le informazioni e forniscigli esattamente ciò che serve. La maggior parte dei non-hacker non vuole saperne di più di quanto è necessario per svolgere il proprio compito e chiunque ne abbia bisogno di più te lo chiederà.
• Come regola generale, quando si tratta di non hacker, qualsiasi e-mail su una pagina stampata di lunghezza (circa 600 parole) è troppo lunga. O riduci la verbosità o beccala la maggior parte su un link a cui puoi fare riferimento o su un documento che puoi allegare. Ad esempio, 2000 parole di documentazione dovrebbero diventare un manuale al quale si collega o si allega alla posta elettronica. Questo rende più facile mantenere la documentazione aggiornata e anche sotto controllo di revisione!

Leggi Strunk & White's The Elements Of Style

Cito: "La scrittura vigorosa è concisa. Una frase non deve contenere parole non necessarie, un paragrafo non frasi inutili, per lo stesso motivo per cui un disegno non dovrebbe avere linee non necessarie e una macchina senza parti non necessarie. Ciò non richiede che lo scrittore faccia tutto le sue frasi brevi, o che evita tutti i dettagli e tratta i suoi soggetti solo in modo sommario, ma che ogni parola dice ".

La mia linea preferita, "Ometti parole inutili".

Scrivi un messaggio sintetico e per cose che pensi che le persone possano desiderare dettagli, fornisci collegamenti ipertestuali a pagine Wiki esterne da Wikipedia, eHow o anche pagine scritte da te.