Ressources de rédaction technique

Cette page résume des ressources supplémentaires de rédaction technique.

Guides de style éditorial

Un guide de style éditorial définit les directives de communication d’un groupe éditorial. Par exemple, laquelle des règles suivantes votre organisation devrait-elle adopter pour les titres ?

• Mettre les titres en casse de phrase (mettre une majuscule uniquement au premier mot de chaque titre)
• Mettre les titres en casse de titre (mettre une majuscule à la plupart des mots de chaque titre)

Ne perdez pas de temps et d’énergie à discuter de ce genre de questions.Au lieu de cela, demandez simplement à votre organisation d’adopter un guide de style rédactionnel particulier.Un guide de style rédactionnel fournit un ensemble de réponses aux questions sur les choix d’écriture. Peu importe qu’un guide de style éditorial préconise la casse des phrases et qu’un autre préfère la casse des titres. Il importe seulement que votre organisation adopte un seul guide de style rédactionnel.

Ah, mais quel guide de style rédactionnel ? Vous connaissez peut-être déjà les guides de style rédactionnel à usage général (tels que le Chicago Manual ofStyle ou le University of Oxford StyleGuide).Toutefois, votre équipe d’ingénieurs doit utiliser un guide de style rédactionnel spécialisé dans la rédaction technique. Nous vous recommandons de choisir l’un des guides suivants :

• Le guide de style de la documentation des développeurs de Google fournit des directives rédactionnelles à toute personne rédigeant de la documentation pour les développeurs dans le cadre de projets liés à Google.
• Le guide de style rédactionnel de Microsoft fournit des directives à toute personne rédigeant de la documentation technique.

Ne rédigez pas votre propre guide de style rédactionnel. La création et le maintien d’un guide de style éditorial « maison » nécessitent des ressources énormes et provoquent d’énormesconflits. Cela dit, certaines organisations inventent une nouvelle terminologie qui n’apparaît pas dans un guide de style rédactionnel existant. Lorsque cela se produit, l’organisation peut faire l’une ou l’autre des choses suivantes :

• Demander aux mainteneurs d’un guide de style éditorial d’ajouter les nouveaux termes.
• Créer et maintenir votre propre guide d’utilisation ou feuille de style qui codifie les orthographes et les usages des mots pour le vocabulaire spécialisé de votre organisation.

Opportunités de documentation de source ouverte

.