Comment gardez-vous les e-mails courts mais complets? [fermé]

Je suis le genre étrange de développeur qui aime écrire et expliquer - les e-mails, les spécifications, vous l'appelez. J'aime aider les gens à comprendre les choses en profondeur. Je déteste les communications de ping-pong où les groupes passent par 30 ou 40 courriels, appels téléphoniques et réunions parce que 25% du groupe ont mal compris le courriel précédent en pointillés dans lequel l'écrivain n'a expliqué qu'à moitié sa position, ou était pressé et a mal écrit un mot critique ou omis un ou deux négatifs.

Cette caractéristique est idéale pour la documentation, mais mes courriels sont longs, donc les gens ne les lisent tout simplement pas. Quelques stratégies que j'ai utilisées consistent à mettre en forme de longs courriels en tant que documents Word joints pour encourager les gens à les voir comme de la documentation (cela fonctionne étonnamment bien parfois), ou à essayer d'utiliser plus de puces au lieu de paragraphes gratuits. Ces stratégies augmentent le lectorat, mais le contenu est encore long.

Bien sûr, je veux crier et crier que les sujets techniques complexes nécessitent beaucoup d'exposition et de clarification, mais cela n'aide personne. De toute évidence, il y a des compromis à faire, mais j'ai du mal à justifier des déclarations qui ne sont pas claires ou qui entraîneront un million de questions, des malentendus ou l'ajout de "termes et conditions" plus tard.

Comment gardez-vous vos communications courtes mais complètes?

Résumé:

Mettez les faits importants en haut puis développez ci-dessous.

Détails:

Lorsque j'ai un long e-mail technique qui, je le crains, ne perdra pas la moitié de l'audience, je fais un effort pour mettre un "résumé exécutif" court et précis en haut, et inclure les détails techniques complets ci-dessous. L'utilisation sélective de caractères gras ou soulignés est également utile.

Concentrez-vous sur ce que vous essayez de communiquer. Est-ce que chaque mot que vous avez utilisé aide à faire passer votre message?

Essayez d'éviter les adjectifs . Évitez les diatribes ou les explications excessives. Utilisez la phrase la plus concise possible - n'essayez pas de paraître impressionnante en utilisant des mots longs et des phrases complexes où une option plus simple existe. Évitez les mots branlants.

Lisez « On Writing » de Stephen King.

J'utilise moins de mots, cela semble faire très bien l'affaire.

sérieusement, tho ...

Essayez seulement d'expliquer les choses qui sont pertinentes, par exemple, "charger un fichier" au lieu d'entrer dans les détails sur la façon dont vous chargez le fichier et vérifiez les erreurs en le faisant et etc. etc.

• Partout où vous le pouvez, créez un lien vers une référence existante lorsqu'une longue explication est nécessaire, au lieu d'inclure l'intégralité de l'explication dans l'e-mail.
• Réfléchissez à ce que le destinataire veut faire des informations et donnez-lui exactement ce qu'il faut. La plupart des non-hackers ne veulent pas en savoir plus que ce dont ils ont besoin pour accomplir leur tâche, et quiconque en a besoin de plus vous le demandera.
• En règle générale, lorsque vous traitez avec des non-pirates, tout e-mail d'une page imprimée (600 mots environ) est trop long. Vous pouvez soit réduire le verbiage, soit en rédiger la majeure partie à un lien auquel vous pouvez faire référence ou à un document que vous pouvez joindre. Par exemple, 2 000 mots de documentation devraient devenir un manuel auquel vous vous connectez ou que vous joignez à l'e-mail. Cela facilite la mise à jour et le contrôle des révisions de la documentation!

Lisez les éléments du style de Strunk & White

Je cite: "Une écriture vigoureuse est concise. Une phrase ne doit pas contenir de mots inutiles, un paragraphe pas de phrases inutiles, pour la même raison qu'un dessin ne doit pas avoir de lignes inutiles et une machine pas de parties inutiles. Cela ne nécessite pas que l'auteur fasse tout ses phrases courtes, ou qu'il évite tous les détails et ne traite ses sujets que dans les grandes lignes, mais que chaque mot raconte. "

Ma ligne préférée, "Omettez les mots inutiles."

Écrivez un message succinct et pour les choses que vous pensez que les gens peuvent vouloir des détails, fournissez des hyperliens vers des pages Wiki externes de Wikipedia, eHow ou même des pages écrites par vous-même.