Rédaction technique
La Rédaction Technique c’est cool!
J’ai commencé la Rédaction Technique il y a plus de 20 ans. Je n’aurais certainement pas été un bon écrivain, car je manque d’imagination quand il s’agit d’écrire. Mais je suis une bonne rédactrice : je sais poser des questions, comprendre, décrire et expliquer. Il ne s’agit pas d’imaginer mais de dire ce qui est et ce qu’il faut faire. Penser comme un développeur et comme un utilisateur à la fois. Montrer l’application (ou l’API, le SDK) sous son meilleur jour. Augmenter la satisfaction de l’utilisateur et celle de l’entreprise grâce à son talent rédactionnel. Oui, la Rédaction Technique c’est cool !
La Rédaction Technique, un travail complexe
Ce qui est vraiment plaisant dans la Rédaction Technique est sa diversité et sa complexité.
- Vous devez être un rédacteur avec des connaissances techniques
- Vous devez penser comme un utilisateur et connaître le logiciel aussi bien (ou presque) que son développeur
- Vous devez exprimer simplement des choses complexes
- Vous devez avoir une pensée claire
- Vous devez savoir utiliser beaucoup d’outils, du traitement de texte aux outils de création d’aide, en passant par l’édition graphique, etc.
- Vous devez maîtriser 2 langues au moins.
Documentation et programmation font la paire
La programmation a toujours un objectif - un usage particulier comblant (ou créant) un besoin, des évolutions - et des utilisateurs, qui s’y connaissent ou non en technique. Dans tous les cas, l’application (ou API) doit être mise en valeur et expliquée, c’est-à-dire documentée, au risque de manquer sa cible. C’est pourquoi la rédaction technique va de pair avec la programmation.
Si votre équipe de développement travaille sur l’un des produits suivants, vous avez besoin de documentation :
- Une application mobile ou un service Web
- Un appareil connecté ou un robot avec une couche applicative
- Une API / SDK
- Un logiciel B-to-C or B-to-B avec des écrans
Une des conséquences d’une mauvaise documentation est que l’utilisateur final (ou le développeur s’il s’agit d’une API) peut se détourner rapidement et rechercher son bonheur auprès d’un concurrent, et/ou submerger le support de questions en tous genres.
C’est sûr, une bonne documentation a de nombreux bénéfices !
L’offre de service Coffee Cup en Rédaction Technique
Coffee Cup se concentre plus particulièrement sur la documentation d’API REST, API & SDK classiques, mais inclut aussi la documentation logicielle, qu’elle soit imprimée ou en ligne.
La documentation peut être rédigée en français, en anglais ou en allemand.
En complément, Coffee Cup propose également des services en Traduction Technique et en Communication Technique.
🔗 Découvrez également mes Favoris.