Beaucoup de gens croient que, pour être un bon écrivain technique, vous devez être un expert en matière de sujet. Et bien que ce soit une erreur courante, il n'est pas surprenant que les gens gardent cette croyance. Après tout, votre travail en tant qu'écrivain technique est de communiquer des informations techniques complexes à un public d'une manière facile à digérer. Bien sûr, les gens s'attendent à ce que vous soyez profondément familiarisé avec le sujet. Heureusement, la réalité est que vous n'avez pas besoin d'être une PME pour écrire un article technique de classe mondiale. Le besoin est la curiosité, la structure et la volonté de poser les bonnes questions à un expert en matière.Et c'est la beauté de l'écriture technique: poser les bonnes questions est plus important que d'avoir toutes les réponses. à Le guide non-SME pour une grande histoire technique Branding votre manque d’expertise comme l’arme qu’elle est Ce manque d’expertise dont vous vous souciez tant vous donne un avantage intéressant – l’opportunité d’aborder le sujet avec le même souci. et Vous posez les questions que les experts oublient de poser (ceux que vos lecteurs demandent également en silence), interrogez chaque concept, décomposez le jargon en langage simple, et en remplissant votre propre lacune de connaissances, donnez au lecteur la meilleure expérience. greenness curiosity https://ucatt.arizona.edu/news/curse-knowledge?embedable=true Construire une relation avec un expert en matière Nous avons établi que vous n'avez pas besoin d'être une PME pour écrire une grande histoire technique, mais Vous avez besoin d'une connexion avec les cerveaux derrière le projet technique / sujet sur lequel vous écrivez. someone Votre travail est alors d’être un pont entre les idées de cette personne et vos lecteurs. Mais voici la chose sur les PME: elles vivent souvent profondément à l'intérieur de la complexité de leurs propres systèmes. Vous êtes là pour tirer ces idées et les traduire en quelque chose qui voyage. Confiez-vous que vous représenterez leur travail avec précision, poserez des questions réfléchies et gérerez leur temps avec respect. build trust. Comment communiquer avec les PME Faites vos devoirs en premier.Ne vous présentez pas à une réunion des PME en blanc.Lire, rechercher et préparer avec des questions spécifiques et intelligentes. Demandez « pourquoi » plus que « quoi ».Le « quoi » vous dit ce qui a été construit ; le « pourquoi » vous dit pour qui il est et pourquoi il importe.Quand vous découvrez le « pourquoi », vous découvrez le contexte du monde réel, ce qui importe de toute façon à vos lecteurs. Clarifier immédiatement la terminologie. Ne pas tromper. Les termes mal utilisés dans une pièce technique peuvent ruiner la crédibilité. Résumez après chaque appel. Envoyez un court suivi avec ce que vous avez compris et assurez-vous que vous êtes sur la même page. Traduire, ne pas transcrire Lorsque vous êtes prêt à mettre le stylo sur le papier, vous devez vous rappeler que votre travail n'est pas de jeter le jargon d'un expert sur la page. En pratique, cela signifie supprimer le jargon en langage simple. Le lecteur sera affecté par le produit / service plutôt que toute la technologie intéressante qui le propulse. Comment Au lieu de dire, dites vous, "Le produit XYZ est génial parce qu'il est construit avec un blah blah de pointe, premier de son genre." "Le produit XYZ, construit avec le blah blah de pointe, est génial parce qu'il vous aide à faire ABC." La première ligne flatte la technologie, la seconde sert le lecteur. À la fin de la journée, vous construisez un pont entre le savoir-faire et la compréhension quotidienne.Plus le pont est clair, plus de gens peuvent le traverser. Vérifiez les faits comme votre vie en dépend Ce n'est pas optionnel, en particulier pour les PME. Les histoires techniques dépendent de l'exactitude. Contrairement à la prose, vos faits doivent être 100% vrais et vérifiables, votre code doit fonctionner, et vos exemples doivent être reproductibles. Exécutez tout - captures d'écran, extraits de code et statistiques - retournez à votre expert pour confirmation. Vous jouez à un jeu de confiance, et rien ne l'érode plus rapidement qu'une erreur qui aurait pu être prise avec un seul e-mail. Racontez l’histoire (mots clés, « Histoire ») Une fois que vous avez vérifié les faits, construisez l'histoire. En fin de compte, l’écriture technique est . écriture Et cela signifie qu'il a besoin de structure, de flux et de paiement. (le problème ou l’objectif), déployer le (votre processus ou découverte), et proche de la (Introduction ou action) why how what next Pour faciliter les choses, nous avons construit un guide pratique basé sur cette structure exacte de 3 actes. Commencez avec cela ici: Technical Storytelling Writing Template. Get started with it here: . Technical Storytelling Writing Template Technique d'écriture de template En conclusion, posez de bonnes questions, écrivez comme si vous l’expliquiez à un ami, et si vous oubliez par où commencer, rappelez-vous que la clarté bat la complexité à chaque fois. Nous espérons que cela vous a donné une certaine clarté (et rassuré vos craintes) sur la navigation dans l'industrie de l'écriture technique sans expertise sur le sujet. Jusqu’à la prochaine fois !
