Como você mantém os e-mails curtos, mas completos? [fechadas]


12

Eu sou o tipo estranho de desenvolvedor que gosta de escrever e explicar - e-mails, especificações, você escolhe. Gosto de ajudar as pessoas a entender as coisas profundamente. Odeio as comunicações de pingue-pongue em que os grupos passam por 30 ou 40 e-mails, telefonemas e reuniões porque 25% do grupo não entendeu o e-mail anterior em que o escritor apenas explicou pela metade sua posição ou estava com pressa e escreveu errado uma palavra crítica ou deixou de lado um negativo ou dois.

Essa característica é ótima para documentação, mas meus e-mails são longos, então as pessoas simplesmente não os lêem. Algumas estratégias que usei são formatar e-mails longos como documentos anexados do Word para incentivar as pessoas a vê-los como documentação (às vezes surpreendentemente funciona bem) ou tentar usar mais marcadores em vez de parágrafos livres. Essas estratégias aumentam o número de leitores, mas o conteúdo ainda é longo.

É claro que quero gritar e gritar que tópicos técnicos complexos exigem muita exposição e esclarecimento, mas isso não ajuda ninguém. Obviamente, existem trocas que podem ser feitas, mas é difícil justificar declarações que não sejam claras ou que resultem em um milhão de perguntas, mal-entendidos ou "termos e condições" adicionados posteriormente.

Como você mantém suas comunicações curtas, mas completas?


1
Não é esse o problema que o Google Wave deveria resolver?
Note to self - pense em um nome

@ Nota: Entre muitos, sim. IMHO, a principal causa de seu desaparecimento foi que estava tentando ser Tudo, para Todos.
Piskvor saiu do prédio 23/03

1
Este não é um problema específico de programação
mattnz

Respostas:


9

Sumário executivo:

Coloque os fatos importantes no topo e expanda abaixo.

Detalhes:

Quando tenho um e-mail técnico longo que, temo, perderá metade da audiência, faço um esforço para colocar um "resumo executivo" breve e preciso no topo e incluir os detalhes técnicos completos abaixo. O uso seletivo de negrito ou sublinhado também ajuda.


Os jornalistas praticam isso: o primeiro parágrafo de uma história deve fornecer a versão tl; dr. Os parágrafos subsequentes expandem a história.
Frank Shearar

Apenas um ponto de esclarecimento, você realmente o rotula como um resumo executivo?
Steven Evers

2
@SnOrfus, absolutamente. Ele o identifica como um resumo, deixa os técnicos da platéia saberem que é uma versão compactada de toda a história e alimenta os egos dos tipos de gerenciamento que, de outra forma, não se incomodariam em lê-la.
ASHelly

Muito interessante. 1
Steven Evers

1
A melhor razão para um resumo executivo de uma linha é que as pessoas ocupadas usam o Blackberrys para manter o controle dos emails e a exibição padrão vale apenas algumas linhas.
precisa saber é o seguinte

2

Concentre-se no que você está tentando se comunicar. Será que cada palavra que você usou ajuda passar a sua mensagem?

Tente evitar adjetivos . Evite reclamar ou explicar demais. Use a frase mais concisa possível - não tente parecer impressionante usando palavras longas e frases complexas onde existe uma opção mais simples. Evite palavras sujas.

Leia ' On Writing ' de Stephen King.


Evite advérbios ainda mais que adjetivos. Eles são quase sempre irrelevantes.
Dan Rosenstark

1

Uso menos palavras, isso parece fazer o trabalho muito bem.

sério, tho ...

Tente apenas explicar as coisas pertinentes, por exemplo, "carregar um arquivo" em vez de entrar em detalhes sobre COMO você carrega o arquivo e verifica se há erros ao fazê-lo, etc. etc.


1
  • Sempre que possível, vincule a uma referência existente quando for necessária uma explicação longa, em vez de incluir toda a explicação no email.
  • Pense no que o destinatário deseja fazer com as informações e forneça exatamente o suficiente para fazer isso. A maioria dos não-hackers não quer saber mais do que precisa para realizar suas tarefas, e qualquer pessoa que precise de mais perguntará a você.
  • Como regra geral, ao lidar com não-hackers, qualquer email com mais de uma página impressa (600 ou mais palavras) é muito longo. Reduza a verborragia ou incline a maior parte para um link que você pode referenciar ou um documento que pode anexar. Por exemplo, 2.000 palavras da documentação devem se tornar um manual ao qual você vincula ou anexa ao email. Isso facilita manter a documentação atualizada e sob controle de revisão também!

1

Leia Os elementos de estilo de Strunk & White

Cito: "A escrita vigorosa é concisa. Uma sentença não deve conter palavras desnecessárias, um parágrafo nem sentenças desnecessárias, pela mesma razão que um desenho não deve ter linhas desnecessárias e uma máquina sem partes desnecessárias. Isso não exige que o escritor faça tudo suas frases curtas, ou que ele evite todos os detalhes e trate seus súditos apenas em linhas gerais, mas que cada palavra diz. "

Minha frase favorita: "Omita palavras desnecessárias".

texto alternativo


O lado bom desse princípio é que ele também se aplica ao código.
Andy Lester

0

Escreva uma mensagem sucinta e, para coisas que você acha que as pessoas podem querer detalhes, forneça hiperlinks para páginas externas da Wiki da Wikipedia, eHow ou mesmo páginas escritas por você.

Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.