Voix et ton
Voix
Chez Docker, nous avons été le client. Nous sommes des développeurs qui développent pour des développeurs. Nous parlons avec expérience et connaissance et sans arrogance ou ego. Nous voulons informer et autonomiser les gens sans être confus ou insistants.
Nous n'avons pas peur d'utiliser un peu d'humour espiègle pour alléger la conversation (et parce que nous ne nous prenons pas trop au sérieux) mais nous sommes toujours respectueux. Nous communiquons avec clarté, empathie et esprit ; tout ce que nous disons devrait informer et encourager.
Nous alignons notre ton de voix et notre contenu avec nos vertus. Les principes les plus importants que nous suivons quand nous écrivons sont les 4C :
- Correct
- Concis
- Complet
- Clair
Nous nous assurons que l'information est précise, succincte, approfondie et facile à comprendre. Nous gardons les phrases aussi simples que possible, mais incluons assez de détails pour que l'utilisateur puisse accomplir la tâche prévue.
Tout cela signifie que quand nous écrivons de la documentation et du texte d'interface utilisateur :
- Nous sommes honnêtes. Nous vous donnons tous les faits et nous n'utilisons pas de détournement ou ne faisons pas de déclarations ambiguës. Nous n'avons pas toujours toutes les réponses, mais nous faisons de notre mieux pour améliorer la vie des développeurs et nous vous dirons comment ça se passe.
- Nous sommes concis. Nous comprenons l'industrie de la messagerie complexe et détaillée dans laquelle vivent nos utilisateurs parce que nous venons du même monde. Docker n'alourdit pas notre communication avec des mots vides ou des métaphores complexes. Nous sommes clairs et directs.
- Nous sommes détendus. Notre comportement est décontracté mais pas paresseux, intelligent mais pas arrogant, et concentré mais pas froid. Notre voix devrait être accueillante et chaleureuse.
- Nous sommes inclusifs. Les développeurs sont des développeurs peu importe combien de code ils ont écrit. Chaque personne fait autant partie de notre communauté que la suivante. Nous acceptons tous les développeurs de toutes les industries et de tous les niveaux d'expérience.
Ton
Le ton de Docker est généralement informel, mais nous croyons qu'il est toujours plus important d'être clair plutôt que comique. Nous sommes détendus, mais nous ne sommes pas inappropriés ou non professionnels.
Ton amical
Utilisez un ton qui est naturel, amical et respectueux sans être trop familier ou plein de jargon. Écrivez pour informer et autonomiser les développeurs sans être confus ou insistant. Il est acceptable d'utiliser des contractions tant que la phrase ne devient pas trop argotique ou informelle.
Évitez d'exagérer la politesse. Il est bon d'être amical et poli, mais utiliser 'veuillez' dans la documentation technique ou le texte d'interface utilisateur pourrait être excessif en politesse.
Langage positif
Utilisez un langage positif. Au lieu de souligner les limitations et ce que les utilisateurs ne peuvent pas faire, mettez l'accent sur les résultats positifs.
Par exemple, au lieu de :
"Les fonctionnalités telles que l'authentification unique (SSO), la gestion d'accès aux images, la gestion d'accès au registre ne sont pas disponibles dans l'abonnement Docker Team."
Utilisez :
"Les fonctionnalités telles que l'authentification unique (SSO), la gestion d'accès aux images, la gestion d'accès au registre sont disponibles dans l'abonnement Docker Business."