Texte de l’interface utilisateur et l’aide de Visual StudioUI Text and Help for Visual Studio

La terminologie et les textes d’interface utilisateurUI text and terminology

Texte compréhensible est cruciale pour l’interface utilisateur efficace.Comprehensible text is crucial to effective UI. Les utilisateurs de logiciels ont tendance à lire les étiquettes tout d’abord, à savoir celles les plus pertinents à l’exécution de la tâche en cours.Software users tend to read labels first, namely those most relevant to completing the task at hand. Texte statique est en lecture avec une fréquence inférieure.Static text is read with less frequency. Plan permettant aux utilisateurs de démarrer des sessions de leur travail avec une analyse rapide de la fenêtre entière, suivie d’une lecture de l’interface utilisateur dans cet ordre approximatif :Plan for users to start their work sessions with a quick scan of the whole window, followed by a reading of the UI in this approximate order:

  1. Contrôles interactifs dans le centreInteractive controls in the center

  2. Valider des boutonsCommit buttons

  3. Contrôles interactifs trouvées ailleursInteractive controls found elsewhere

  4. Instructions principalesMain instructions

  5. Obtenir des explications supplémentairesSupplemental explanations

  6. Titre de la fenêtreWindow title

  7. Tout autre texte statique dans le corps principalOther static text in the main body

Modèles d’utilisation pour le texte de l’interface utilisateurUsage patterns for UI text

Texte de barre de titreTitle bar text

Texte de barre de titre doit correspondre à la commande qui a généré l’interface utilisateur.Title bar text must match the command that spawned the UI.

Texte d’instructions (texte d’assistance)Instructional text (helper text)

Dans certaines boîtes de dialogue, il est utile de fournir les principales instructions principales pour expliquer que faire dans la fenêtre ou dans la page.In some dialogs, it is helpful to provide prominent main instructions to explain what to do in the window or in the page. Cela est parfois appelé « texte d’assistance ».This is sometimes referred to as "helper text."

Écriture de règles de style pour le texte d’aideWriting style rules for helper text
  • N’expliquent pas les évidents.Don't explain the obvious. Sauf si elle est absolument nécessaire, n’incluez pas le texte d’instructions.Unless it is absolutely needed, do not include instructional text.

  • Texte d’instructions est toujours placé en haut de la boîte de dialogue et doit faire référence à la tâche en cours d’exécution.Instructional text is always placed at the top of the dialog and should refer to the task being performed.

  • Expliquer précisément aux utilisateurs qu’ils doivent faire.Precisely explain to users what they need to do. Éviter la redondance et la communication excessive.Avoid excessive communication and redundancy.

  • Passez en revue chaque fenêtre et éliminer les instructions et les mots en double.Review each window and eliminate duplicate words and statements.

  • Conserver le texte d’instructions court.Keep instructional text short. Si plus d’informations est nécessaire pour certains utilisateurs ou scénarios, indiquez un lien vers une rubrique en ligne conceptuelle détaillée.If more information is necessary for certain users or scenarios, then provide a link to a detailed conceptual online topic.

  • Écrivez votre texte afin que chaque mot conserve le poids et n’est nécessaire.Write your text so that every word holds weight and is necessary.

  • Suivez les conseils de Microsoft existant pour texte de l’Interface utilisateur et Style et le ton.Follow existing Microsoft guidance for User Interface Text and Style and Tone.

Obtenir des instructions supplémentairesSupplemental instructions

Obtenir des instructions supplémentaires fournissent des informations supplémentaires qui aide l’utilisateur à comprendre les contrôles ou de contrôler les regroupements.Supplemental instructions provide additional information that helps the user understand controls or control groupings. Cela peut également inclure le texte d’indication nécessaire pour comprendre quel format le contrôle d’entrée est attendu.This could also include hint text necessary to understand what format the input control is expecting. Utilisez des instructions supplémentaires avec parcimonie.Use supplemental instructions sparingly. Les réserver pour les cas où il est probable que l’utilisateur ne comprenez pleinement les conséquences du choix qu’ils font.Reserve them for cases where it's likely that the user won't fully understand the ramifications of the choice they are making.

Texte supplémentaire dans Visual StudioSupplemental text in Visual Studio

Texte supplémentaire dans Visual StudioSupplemental text in Visual Studio

Texte supplémentaire dans Visual StudioSupplemental text in Visual Studio

Texte supplémentaire dans Visual StudioSupplemental text in Visual Studio

Info-bullesInfoTips

Souvent, le texte d’instructions est peut-être trop long pour positionner sur place dans l’interface utilisateur ou peut être utile uniquement aux nouveaux utilisateurs, une sensation encombrement aux utilisateurs expérimentés.Often, the instructional text might be too lengthy to position in-place in the UI or might be useful only to new users, feeling like clutter to experienced users. Dans ce cas, le texte d’instructions / d’information doit être placé comme une info-bulle sous une info-bulle.In this case, the instructional/informational text should be placed as a tooltip under an InfoTip.

Info-bulle doit être placé à proximité des contrôles qu’ils sont liés à et doivent utiliser l’icône d’info-bulle spécifique, qui est encore discrète notable.InfoTips should be placed near the controls that they are related to and should use the specific InfoTip icon, which is unobtrusive yet noticeable.

Info-bulle dans Visual StudioInfoTip in Visual Studio

Exemple d’une info-bulle dans Visual StudioExample of an InfoTip in Visual Studio

Règles de style d’écriture pour les info-bullesWriting style rules for InfoTips
  • Écrire des info-bulles sous forme de phrases complètes.Write InfoTips as complete sentences. Ils nécessitent des verbes spécifiques, le cas de phrase et la ponctuation de fin.They require specific verbs, sentence case, and ending punctuation.

  • Utilisez des info-bulles pour compléter votre instruction principale ou des informations.Use InfoTips to supplement your main instruction or information. Si vous utilisez simplement les différents mots de retraiter l’idée principale, vous n’avez pas besoin une info-bulle.If you are just using different words to restate the main idea, you don't need an InfoTip.

  • Conserver les info-bulles bref et concis.Keep InfoTips short and sweet. Utiliser des petits mots et brut, en langage naturel qui prend en charge et encourage l’utilisateur.Use small words and plain, everyday language that supports and encourages the user.

  • Suivez les conseils de Microsoft existant pour texte de l’Interface utilisateur et Style et le ton.Follow existing Microsoft guidance for User Interface Text and Style and Tone.

Étiquettes de contrôleControl labels

Étiquettes de contrôle doivent être court et concise, suivez le des conseils de bureau de Windows pour les contrôles.Control labels should be short, concise, and follow the Windows Desktop guidance for Controls.

Pour plus d’informations sur le format d’étiquette de contrôle et de placement au sein de l’interface utilisateur, consultez Layout for Visual Studio.For more information about control label format and placement within the UI, refer to Layout for Visual Studio.

Liens d’aide peuvent soit être placés dans le texte d’instructions ou dans le corps de l’interface utilisateur.Help links can either be placed within instructional text or in the body of the UI. Ils peuvent être des liens vers l’aide ou lancez l’internes boîtes de dialogue.They can be links to Help or launch internal dialogs.

  • Utiliser les couleurs de l’environnement approprié pour les liens hypertexte.Use the correct environment colors for hyperlinks. Un lien hypertexte correctement stylé pas brièvement clignote en rouge lorsque vous cliquez sur.A properly styled hyperlink will not briefly flash red when clicked. Si vous le voir, il est une indication que les couleurs de l’environnement ne sont pas utilisés.If you see this, then it is an indication that environment colors are not being used.

  • Soulignements doivent uniquement être utilisées sur pointage ou lorsque le lien est incorporé dans un paragraphe.Underlines should only be used on hover or when the link is embedded in a paragraph.

  • Pour obtenir des informations plus détaillées sur les styles visuels et l’interaction des liens hypertexte, consultez les boutons et des liens hypertexte.For more detailed information on visual and interaction styles for hyperlinks, see Buttons and hyperlinks.

  • Lors du lancement de boîtes de dialogue, mettre à jour les normes pour les points de suspension : aucun bouton de sélection pour la navigation, si la tâche requiert une interface utilisateur supplémentaire des points de suspension.When launching dialogs, maintain the standards for ellipses: no ellipsis for navigation, ellipses if the task requires additional UI.

    Lien d’aide dans Visual StudioHelp link in Visual Studio

    Points de suspension (...) dans un lien d’aide indique que la tâche nécessite une interface utilisateur supplémentaire.An ellipsis (...) in a Help link indicates the task will require additional UI.

  • Liens ne doivent pas commencer par « Apprentissage », car il se n'agit pas d’intention de l’utilisateur.Links should not start with "Learn," as that is not the user's intent. L’utilisateur souhaite répondre à une question spécifique, pas recevoir une formation générale.The user wants to answer a specific question, not receive a general education.

  • Les liens d’aide d’une expression afin qu’ils poser la question que la rubrique répondra.Phrase help links so that they ask the question that the topic will answer.

    Incorrect :Incorrect:
    « En savoir plus sur la tarification Windows Azure Mobile Services »"Learn more about Windows Azure Mobile Services pricing"

    Corriger :Correct:
    « Quelles options de tarification sont disponibles pour Windows Azure Mobile Services ? »"What pricing options are available for Windows Azure Mobile Services?"

  • N’utilisez jamais cliquez sur... pour le texte du lien.Never use Click... to the link text.

  • Ne jamais lier uniquement le mot « ici ».Never link only the word "here." Cela peut être problématique pour certains lecteurs d’écran, qui seront vocal uniquement le lien hypertexte mot.This is problematic for some screen readers, which will voice only the hyperlinked word.

    Incorrect :Incorrect:
    « Rechercher des informations sur Windows Azure Mobile Services ici»"Find information on Windows Azure Mobile Services here"

    Corriger :Correct:
    « Quelles options de tarification sont disponibles pour Windows Azure Mobile Services ? »"What pricing options are available for Windows Azure Mobile Services?"

  • Pour plus d’informations sur le style rédactionnel correct pour les liens d’aide, consultez le conseils Windows Desktop aide.For more information on the correct writing style for Help links, see the Windows Desktop guidance for Help.

Texte d’indicationHint text

Texte d’indication apparaît en filigrane dans un contrôle ou sous le contrôle.Hint text appears as a watermark within a control or below the control. Mise en forme correcte s’appliquera à l’aide du jeton VSColors approprié, Environment.GrayText.Correct formatting will be applied by using the appropriate VSColors token, Environment.GrayText.

Elle peut apparaître dans plusieurs formes.It can appear in a number of forms.

  • À la place de l’étiquette de contrôle :In place of the control label:

    Indicateur de texte dans Visual StudioHint text in Visual Studio

  • Avec un verbe, ce qui donne des instructions :With a verb, giving instructions:

    Indicateur de texte dans Visual StudioHint text in Visual Studio

  • Avec le texte qui indique une entrée requise :With text indicating a required entry:

    Indicateur de texte dans Visual StudioHint text in Visual Studio

Texte de filigraneWatermark text

Sur une aire de conception vide, le texte doit indiquer ce qu’il faut effectuer ainsi que de fournir des liens pour ouvrir d’autres fenêtres associées, le cas échéant :On an empty design surface, the text should indicate what to do as well as provide links to open other related windows, if appropriate:

Un texte dans Visual Studio en filigraneWatermark text in Visual Studio

Exemple de texte de filigrane dans Visual StudioExample of watermark text in Visual Studio

Terminologie couranteCommon terminology

TermeTerm ExplicationExplanation CommentaireComment
Se connecter / déconnecterSign in / Sign out Verbes utilisés indifféremment avec le web pour représenter l’authentification dans une propriété web.Verbs used synonymously with the web for representing authentication into a web property. Dans les clients, nous utilisons cette fois comme une notion de niveau supérieur pour la signature dans et hors connexion d’utilisateur de l’IDE, ce qui représente une identité de niveau supérieur qui fournit des fonctionnalités de niveau supérieur tels que l’itinérance et de gestion des licences qui ne sont pas disponibles avec toutes les autres connexions.Within clients, we use this once as a top-level notion for signing in and out of IDE user connection, which represents a top-level identity that provides higher-level capabilities such as roaming and licensing that are not available with all other connections. L’utilisateur de l’IDE est la seule fonctionnalité qui doit représenter une connexion / déconnexion verbe, car il représente l’utilisateur IDE de niveau supérieur.The IDE User is the only feature that should represent a sign in / sign out verb, as it represents the top-level IDE user.
Connecter / déconnecterConnect / Disconnect Utiliser dans des lieux où une fonctionnalité conserve une connexion unique à un service en ligne.Use in places where a feature maintains a single connection to an online service. Explorateur de serveurs, où vous ne pouvez avoir qu’une seule connexion d’Azure active à la fois, est un exemple de connecter/déconnecter.Server Explorer, where you can only have one active Azure connection at a time, is an example of Connect/Disconnect.
Ajouter / supprimerAdd / Remove Non destructif.Non-destructive. À utiliser lorsque l’ajout ou la suppression d’éléments dans une liste.Use when adding or removing something from a list. La boîte de dialogue Gestionnaire de connexions TFS server liste est un exemple d’ajout/suppression.The TFS Connection Manager server list dialog is an example of Add/Remove.
SupprimerDelete Destructeur.Destructive. Utilisez uniquement lorsque l’élément en cours de suppression est définitivement rejeté ou supprimé à partir du disque.Use only when the element being removed will be permanently discarded or deleted from the disk. « Supprimer » requiert généralement une invite si le résultat est si vous supprimez un fichier de disque."Delete" generally requires a prompt if the result is deleting a file from disk.

Messages d’erreurError messages

Vue d'ensembleOverview

Des erreurs se produisent.Errors happen. Définition des limitations sur l’utilisateur peut effectuer est une première étape à empêcher les messages d’erreur évitable raisonnable.Setting limitations on what the user can do is a sensible first step in preventing avoidable error messages. Toutefois, lorsqu’une erreur se produit, un message d’erreur bien écrite peut accéder un long chemin pour atténuer le problème.However, when an error does occur, a well-written error message can go a long way toward mitigating the problem. Messages d’erreur sont sans doute un des types plus importants de notification que l’utilisateur voit, parce qu’ils sont synchrones et indiquent un problème qui doit être résolu.Error messages are arguably one of the most important types of notification that the user sees, because they are synchronous and indicate a problem that needs to be solved. Messages d’erreur mal écrit laissent les utilisateurs sur leurs propres pour déterminer la cause des erreurs et les solutions possibles.Poorly written error messages leave users on their own to decide the cause of the errors and any possible solutions.

Les utilisateurs peut s’arrêter en faisant attention à l’utilisation excessive ou confusion entre les messages d’erreur, afin de l’expérience de l’écriture des messages uniquement nécessaires valeur ajoutée à l’utilisateur.Users might stop paying attention to overused or confusing error messages, so write only necessary messages that add value to the user experience. Si le message est simplement une notification, puis utiliser une autre présentation.If the message is simply a notification, then use an alternative presentation.

Règles de création d’un message d’erreurRules for creating an error message

  • Lors de la construction de messages d’erreur, choisissez le niveau d’erreur approprié pour le public.When constructing error messages, choose the appropriate error level for the audience. L’objectif est de résumés simples qui fournissent une action à que l’utilisateur peut exécuter, le cas échéant.Aim for straightforward summaries that provide an action the user can take, if applicable. État de ne pas tout ce que l’utilisateur n’a pas besoin de connaître.Don't state anything that the user does not need to know.

  • Fournir une assistance constructif.Provide constructive assistance. Il est plus facile à lire et agir sur un message d’erreur qui contient l’instruction.It's easier to read and act on an error message that contains instruction.

  • N’utilisez pas deux négatifs.Don't use double negatives.

  • Effectuer les deux un moyen automatisé et manuel grammaire et l’orthographe vérifier sur n’importe quel message d’erreur que vous écrivez.Perform both an automated and a manual grammar and spelling check on any error message you write.

  • Pour les messages d’erreur complexes, évitez de communications séquentielles.For complex error messages, avoid sequential communications. N’utilisez jamais une accroche F1 pour le message d’erreur.Never use an F1 hookup for the error message. Le message lui-même doit être suffisant.The message itself should be sufficient.

  • Utilisez l’icône correcte.Use the correct icon.

  • Formuler des questions faciles à comprendre et utiliser les boutons qui ont un choix clair, tels que « Supprimer » et « Annuler ».Make questions easy to understand and use buttons that have clear choices, such as "Delete" and "Cancel."

  • Pour les avertissements, être clair sur ce que sera la conséquence de continuer.For warnings, be clear about what the consequence of proceeding will be. Les boutons doivent indiquer la conséquence.The buttons should indicate the consequence.

  • Pour les erreurs, décrivent ce que l’utilisateur peut faire pour résoudre le problème.For errors, describe what the user can do to fix the problem. Boutons doivent être des actions ou dire « Fermer ».Buttons should be actions or say "Close." N’utilisez pas un bouton « OK » pour un message d’erreur.Don't use an "OK" button for an error message.

  • Quelques questions à poser lors de la construction d’un message d’erreur :Some questions to ask yourself when constructing an error message:

    • L’utilisateur vous rendiez compte comment résoudre le problème avec cette erreur autonome ?Can the user figure out how to solve the issue with this error alone?

    • L’utilisateur utilise-t-elle le vocabulaire de même que cette erreur ?Does the user use the same vocabulary as this error?

    • Est ambigu de cette erreur, ou partagés dans plusieurs situations ?Is this error ambigious or shared in multiple situations? Dans ce cas, comment vous guident les utilisateurs à la solution que dont ils ont besoin ?If so, how do you guide users to the solution they need?

Erreurs de buildBuild errors

Dans la mesure où Visual Studio est un outil de développement logiciel, la plupart de ses composants ont une compilation, la conversion ou encodage étape pour convertir le travail du développeur sous forme binaire.Since Visual Studio is a software development tool, many of its components have a compilation, converting, or encoding step to convert the developer's work to binary form. Ces conversions peuvent provoquer des erreurs lorsque le compilateur ne peut pas traiter les fichiers créés de manière incorrecte ou lorsque les options du compilateur n’ont pas été correctement définies.These conversions can cause errors when the compiler cannot process improperly authored files or when compiler options weren't set correctly.

Utilisateurs de Visual Studio peuvent passer une quantité énorme de résolution des erreurs de build d’heures de développement.Visual Studio users can spend an enormous number of development hours resolving build errors. Ce délai de résolution augmente lorsque les erreurs ont des dépendances ou lorsque les messages d’erreur sont mal écrit, ce qui peut rendre difficile de découvrir la source de l’erreur.This resolution time increases when errors have dependencies or when error messages are poorly written, which can make it difficult to uncover the source of the error.

Des erreurs de build sont ceux qui ne se produisent pas dans le premier lieu, c’est pourquoi Visual Studio fournit la saisie semi-automatique et IntelliSense tildes.The best build errors are those that don't occur in the first place, which is why Visual Studio provides AutoComplete and IntelliSense squiggles. Validateurs de schéma et des outils similaires fournissent le même type de commentaires.Schema validators and similar tools provide the same kind of feedback. Ces mécanismes guident proactivement l’utilisateur pour construire un code bien formé, réduisant le risque d’erreurs de build.These mechanisms proactively guide the user to construct well-formed code, lessening the chance of build errors.

Visual Studio fournit une fenêtre outil où les utilisateurs peuvent lire et parcourir les erreurs qui se sont produites dans leur fenêtre de document.Visual Studio provides a tool window where users can read and navigate through the errors that occurred in their document windows. Raccourcis clavier sont fournis pour que l’utilisateur peut naviguer rapidement grandes quantités de code et accéder directement à l’emplacement du problème.Keyboard shortcuts are provided so that the user can quickly navigate large amounts of code and go directly to the location of the problem. Visual Studio permet également de chaque erreur de build d’être associé à un ID de mot clé/contexte d’aide particulier, afin que l’utilisateur peut accéder directement à une rubrique d’aide qui donne des informations plus détaillées sur l’erreur.Visual Studio also allows each build error to be tied to a particular Help keyword/context ID so that the user can go directly to a Help topic that gives more in-depth information about the error.

Écrire les erreurs de build clairs et concis :Write clear, concise build errors:

  • Utiliser un langage simple qui explique le problème avec peu ou pas jargon du compilateur.Use plain language that explains the problem with little or no compiler jargon. Le texte d’une erreur de build ne doit pas être trop technique.The text of a build error should not be overly technical.

  • Décrit les causes possibles.Outline possible causes. Par exemple, « manque un signe deux-points entre la propriété et la valeur dans le ' (propriété) : (valeur)' déclaration. »For example, "Missing a colon between the property and value in the '(property) : (value)' declaration."

  • Fournissez des détails sur les corrections éventuelles.Give details about potential fixes. Si l’espace n’est pas suffisant, des détails supplémentaires peuvent être mis dans la rubrique d’aide correspondante.If there is not enough room, then additional details may be put into the corresponding Help topic.

Composants d’un message d’erreur bien écritsComponents of a well-written error message

Utiliser le service de boîte de dialogue d’interpréteur de commandes pour les messages d’erreur.Use the shell dialog service for error messages.

L’utilisation du service de boîte de dialogue d’interpréteur de commandes vous permet de contrôler l’apparence du message, polices, en particulier, sans modification majeure aux éléments individuels.Using the shell dialog service lets you control the appearance of the message, fonts in particular, without major changes to individual elements. Utilisez le IErrorInfo mécanismes et les signaler à l’aide de IVsUIShell::SetErrorInfo/ReportErrorInfo.Use the IErrorInfo mechanisms and report them using IVsUIShell::SetErrorInfo/ReportErrorInfo.

Choisir une présentation de notification efficaces et appropriés.Choose an effective and appropriate notification presentation.

Utilisez la boîte de dialogue modale avec un avertissement critique si une action immédiate est nécessaire pour éviter une perte de données (notification synchrone).Use a modal dialog with a critical warning if immediate action is required to avoid loss of data (synchronous notification). Icônes critiques sont réservés pour les situations dans le message sans effectuer de lecture de fermeture, cela peut entraîner des conséquences négatives.Critical icons are reserved for situations in which closing the message without reading it can lead to negative consequences. Perte de données est une situation critique qui nécessite une réponse au niveau de l’alarme.Loss of data is a critical situation that requires an alarm-level response. Utilisation excessive de l’icône critique desensitizes aux utilisateurs de son importance.Overuse of the critical icon desensitizes users to its importance. Si le message d’erreur est de nature informationnelle, prendre en compte les alternatives à la boîte de dialogue modale (notification asynchrone).If the error message is informational in nature, consider alternatives to a modal dialog (asynchronous notification).

Fournir une explication de nette et succincte de la cause du problème au lieu d’obtenir une explication technique.Provide a clean, succinct explanation of why the problem occurred rather than a technical explanation.

Surcharger les utilisateurs avec des détails techniques dans l’explication rend les plus susceptibles d’ignorer les messages d’erreur.Overburdening users with technical details in the explanation will make them more likely to ignore error messages. Exemples de bon de messagerie :Examples of good messaging:

  • « Impossible d’ouvrir le fichier demandé. »"Unable to open the requested file."

  • « Impossible de se connecter à Internet. »"Unable to connect to the Internet."

Fournissent des informations sur la façon de résoudre le problème.Provide information about how to fix the problem.

Des suggestions l’utilisateur pour résoudre le problème.Offer the user suggestions of how to fix the problem. Être honnêtes avec l’utilisateur s’il en existe aucune suggestion.Be honest with the user if there are no suggestions. Fournir des liens directs vers les autres sources en ligne, telles que le support technique ou le support de la Communauté.Provide direct links to alternative online sources, such as technical support or community support. Essayez dirigent les utilisateurs vers des informations en ligne spécifiques pertinentes pour le problème.Try to point users to specific online information pertinent to the issue. Pour un ID d’erreur, envisagez de lier des utilisateurs à un thread de discussion sur l’erreur concernée.For an error ID, consider linking users to a discussion thread about that specific error. Exemples de bon de messagerie :Examples of good messaging:

  • « Vérifiez que vous êtes connecté à Internet et recommencez l’opération. »"Make sure that you are connected to the Internet and try this operation again."

  • « Vérifiez que le fichier existe et que vous êtes autorisé à ouvrir. »"Make sure that the file exists and that you have permission to open it."

Écrire un message qui est à court et au point.Write a message that is short and to the point.

Un message d’erreur peut notifier, expliquer et offrir une solution, mais toujours être ignorée si elle est trop longue.An error message can notify, explain, and offer a solution but still be ignored if it's too wordy. Une solution consiste à utiliser l’affichage progressif avec un bouton Détails.One solution is to use progressive disclosure with a details button. Par exemple, donner une courte description/solution, puis entrer plus de détails sous un bouton Détails.For example, give a short description/solution and then put more details under a details button. Si les utilisateurs choisissent d’en savoir plus sur l’erreur, il peuvent le faire.If users choose to read more information on the error, they can do so.

La langue dans le message doit être :The language in the message should be:

  • Domaine approprié.Domain-appropriate. Utiliser le langage de que l’utilisateur comprenne.Use language the user will understand. Bien que nos clients sont des développeurs, ils n’ont souvent le contexte et la terminologie que nous avons.Even though our customers are developers, they often don't have the context and terminology we have.

  • Spécifique.Specific. Évitez les vagues libellé et donner des noms spécifiques et les emplacements des objets impliqués.Avoid vague wording and give specific names and locations of objects involved. Par exemple, un message d’erreur tels que « le caractère non valide » n’est pas utile.For example, an error message such as "character is invalid" is not useful. Le caractère ?Which character? « Fichier introuvable »."File not found." Quel fichier ?Which file?

  • Courtoise.Courteous. Ne pas rendre responsable de l’utilisateur ou Rabaissez.Don't blame the user or make them feel stupid. Éviter de langage hostile ou offensant (arrêter, exécuter, arrêter, irrécupérable, non conforme).Avoid hostile or offensive language (kill, execute, terminate, fatal, illegal). Évitez le texte en majuscules, ce qui est souvent considéré comme trouver et n’est pas comme lisible.Avoid uppercase text, which is often seen as shouting and is not as readable. N’utilisez pas humour.Don't use humor.

  • Corriger.Correct. Utilisation correcte de grammaire et orthographe (même prémultipliés).Use correct spelling and grammar (even in alphas). Fautes de frappe sont non professionnelle et ennuyeux.Typos are unprofessional and embarrassing.

  • En fonction du contexte approprié.Contextually appropriate. Utilisez le texte du bouton approprié.Use appropriate button text. Éviter le bouton « OK » et à la place utiliser « Continuer » ou « Yes/No ».Avoid the "OK" button and instead use "Continue" or "Yes/No."

Exemples de messages d’erreurError message examples

BonGood incorrecteBad
« Le nombre que vous avez composé est retiré du service."The number you dialed is no longer in service. Veuillez vérifier le numéro et recomposer ou composez le 0 pour l’opérateur. »Please check the number and dial again or dial 0 for the operator." -« Erreur (449) : nombre non conforme »- "Error (449): Illegal number"
-« Cette erreur d’exception non gérée indique que l’opération a réussi. »- "This unhandled exception error indicates that the operation completed successfully."

Message d’erreur incorrect dans Visual StudioBad error message in Visual Studio

Accéder à l’aideAccessing Help

Vue d'ensembleOverview

En plus de documentation dans MSDN, un utilisateur de Visual Studio a plusieurs points d’accès pour aider l’utilisateur dans l’interface utilisateur.In addition to documentation in MSDN, a Visual Studio user has several access points to assist the user while in the UI. Pour vous assurer que ces points d’accès sont constamment disponibles, les équipes fonctionnelles doivent tirer parti du système d’aide proposé par l’environnement.To ensure that these access points are consistently available, feature teams need to take advantage of the Help system offered by the environment. Ces points d’accès sont :These access points are:

  • Texte pédagogique et supplémentaire dans les boîtes de dialogue.Instructional and supplemental text in dialogs. Texte statique qui donne une direction ou explication, soit sur l’interface utilisateur de surface ou disponible sur le pointage sur une icône d’info-bulle.Static text that gives direction or explanation, either on the UI surface or available on hover over an InfoTip icon.

  • Aide (F1) (éditeur uniquement).F1 Help (editor only). Dans l’éditeur Visual Studio, un utilisateur peut faire confiance qu’à tout moment, en appuyant sur F1 fera apparaître une rubrique d’aide spécifique à la sélection actuelle.Within the Visual Studio editor, a user can trust that at any time, pressing F1 will bring up a Help topic specific to the current selection. Assurez-vous que les rubriques associées F1 sont appropriées et informatifs.Ensure that topics associated with F1 are appropriate and informative.

  • Liens hypertexte vers des rubriques d’aide.Hyperlinks to Help topics. Un lien hypertexte dans une boîte de dialogue, une fenêtre outil ou une aire de conception qui lance une rubrique pour aider l’utilisateur en savoir plus sur une technologie, fonctionnalité ou d’informations sur la façon d’accomplir une tâche.A hyperlink within a dialog, tool window, or design surface that launches a topic to assist the user in learning more about a technology, capability, or information about how to accomplish a task.

  • Mécanismes de l’interface utilisateur d’assistance, telles que les balises actives et les boîtes de dialogue de création.Helper UI mechanisms, such as smart tags and building dialogs. Ces mécanismes aider l’utilisateur à comprendre un élément d’interface utilisateur ou facilitent une tâche, telle que les balises actives ou des boîtes de dialogue Générateur de rapports.These mechanisms assist the user in understanding a UI element, or facilitate a task, such as smart tags or builder dialogs.

  • Boutons d’aide de l’interface utilisateur (déconseillé).UI Help buttons (deprecated). Un indicateur visible dans la barre de titre qui donne accès à la rubrique d’aide (F1) associée.A visible indicator in the title bar that gives access to the related F1 Help topic.

TexteText

Texte pédagogique et supplémentaire dans les boîtes de dialogueInstructional and supplemental text in dialogs

Dans les boîtes de dialogue qui prennent en charge des tâches complexes, il peut être nécessaire de donner à texte d’instructions au sein de l’interface utilisateur, souvent en haut de la boîte de dialogue ou à proximité des contrôles complexes.In dialogs that support complex tasks, there might be a need to give instructional text within the UI, often at the top of the dialog or near complex controls. Consultez l’interface utilisateur texte et la terminologie pour plus d’informations sur l’écriture de style.See UI text and terminology for details on writing style.

Info-bullesInfoTips

Souvent, un texte d’instructions est peut-être trop long pour positionner en place dans l’interface utilisateur ou peut être utile uniquement aux nouveaux utilisateurs, l’encombrement aux utilisateurs expérimentés une sensation.Often, instructional text might be too lengthy to position in place in the UI or might be useful only to new users, feeling like clutter to experienced users. Dans ce cas, le texte d’instructions / d’information doit être placé comme une info-bulle sous une info-bulle.In this case, the instructional/informational text should be placed as a tooltip under an InfoTip.

Info-bulle doit être placé à proximité des contrôles qu’ils sont liés à et doivent utiliser l’icône d’info-bulle spécifique, qui est encore discrète notable.InfoTips should be placed near the controls that they are related to and should use the specific InfoTip icon, which is unobtrusive yet noticeable.

Info-bulle dans Visual StudioInfoTip in Visual Studio

Exemple d’une info-bulle dans Visual StudioExample of an InfoTip in Visual Studio

Mécanismes d’aide interactivesInteractive Help mechanisms

F1 AideF1 Help

Aide (F1) est requis dans un éditeur ou l’aire de conception, mais pas ailleurs dans l’environnement Visual Studio.F1 Help is required within an editor or design surface, but not elsewhere in the Visual Studio environment.

Liens hypertexte peuvent être utilisés pour effectuer une action, naviguer dans l’IDE ou lancer l’aide dans un navigateur.Hyperlinks can be used to perform an action, navigate within the IDE, or launch Help in a browser. Consultez l’interface utilisateur texte et la terminologie pour plus d’informations sur le langage et 07.10.01 boutons et des liens hypertexte pour obtenir des instructions visuel et de mise en page.See UI text and terminology for details on language and 07.10.01 Buttons and hyperlinks for visual and layout guidelines.

Aide des boutons [ ?] dans les barres de titre de boîte de dialogue (déconseillées)Help [?] buttons in dialog title bars (deprecated)

La plupart du temps, les boutons d’aide [ ?] dans la barre de titre des boîtes de dialogue sont déconseillés.For the most part, the Help [?] buttons in the title bar of dialogs are deprecated. Rubriques de l’interface utilisateur ne font plus partie de notre modèle de document, et par conséquent, il peut revêtir une rubrique appropriée à lier à.UI topics are no longer part of our doc model, and therefore there might not be a relevant topic to link to. Essentiellement, le bouton de barre de titre a été la même chose que la touche F1, et qui n’est plus nécessaire dans les boîtes de dialogue.Essentially, the title bar button was the same thing as F1 Help, and that is no longer required in dialogs. Dans certains cas, cela peut toujours être utilisée comme un indicateur que plus d’informations conceptuelles ou de procédures est disponible, bien que les liens hypertexte sont plus couramment utilisés dans l’interface utilisateur plus récente.In some instances, this can still be used as an indicator that there is more conceptual or procedural information available, although hyperlinks are more commonly used in newer UI.

Boîtes de dialogue créées par l’environnement.Dialogs created through the environment

Nombreuses boîtes de dialogue shell sont créés via le VBDialogBoxParam (fonction).Many shell dialogs are created through the VBDialogBoxParam function. Cette fonction partagée a été mis à jour pour aider lors du déplacement de la aide bouton à partir de la boîte de dialogue le ?This shared function was updated to assist in moving the Help button from the dialog to the ? bouton tout en conservant une architecture en amont compatible et extensible.button while retaining an architecture that is backward compatible and extensible.

Plus précisément, le VBDialogBoxParam fonction examine le modèle de boîte de dialogue pour un bouton dont l’ID est IDHELP (9) ou de l’étiquette est aide ou & aide.Specifically, the VBDialogBoxParam function looks at the dialog template for a button whose ID is IDHELP (9) or label is Help or &Help. Si un bouton aide est trouvé, il est masqué et le WS_EX_CONTEXTHELP style est ajouté à la boîte de dialogue, ce qui place le ?If a Help button is found, it is hidden and the WS_EX_CONTEXTHELP style is added to the dialog, which places the ? bouton dans la barre de titre de la boîte de dialogue.button in the dialog's title bar.

Quand la boîte de dialogue est créée, elle exécute un push de la procédure de boîte de dialogue dans une pile et appelle la boîte de dialogue avec une procédure de boîte de dialogue pré-traitement nommée DialogPreProc.When the dialog is created, it pushes the dialog proc onto a stack and invokes the dialog with a pre-processing dialog proc named DialogPreProc. Lorsque le ?When the ? bouton est activé, il envoie un WM_SYSCOMMAND de SC_CONTEXTHELP à la boîte de dialogue.button is clicked, it sends a WM_SYSCOMMAND of SC_CONTEXTHELP to the dialog. Le DialogPreProc capture cette commande et la remplace par une WM_HELP message, qui est passé à la procédure de boîte de dialogue d’origine.The DialogPreProc captures this command and changes it to a WM_HELP message, which is passed to the original dialog proc.

La plupart des boîtes de dialogue environnement créé ont un bouton d’aide sur la boîte de dialogue.Most environment-created dialogs have a Help button on the dialog. Lorsque la boîte de dialogue s’affiche, le bouton aide est masquée automatiquement et uniquement le ?When the dialog is displayed, the Help button is auto-hidden and only the ? fonctionnement du bouton.button works. Si le ?If the ? bouton est jamais supprimé ou modifié dans Windows, cette solution vous permet de ramener rapidement vers les boutons d’aide d’origine.button is ever removed or changed in Windows, this solution allows you to quickly move back to the original Help buttons.

Cette solution sur les hypothèses quatre qui pourrait provoquer des bogues :This solution makes four assumptions that could cause bugs:

  • Bouton d’aide de la boîte de dialogue est IDHELP (9).The dialog's help button is IDHELP (9).

  • La boîte de dialogue semble correcte lorsque le bouton aide est masqué.The dialog looks correct when the Help button is hidden.

  • La boîte de dialogue ne remplace pas sa fonction winproc.The dialog does not substitute its winproc.

  • La boîte de dialogue n’est pas incorporé à l’intérieur d’une autre boîte de dialogue.The dialog is not embedded inside of another dialog.

    Si votre boîte de dialogue se trouve dans msenv et n’utilise pas VBDialogBoxParam, parti VBDialogBoxParam avant d’implémenter votre propre gestionnaire.If your dialog resides within msenv and doesn't use VBDialogBoxParam, investigate leveraging VBDialogBoxParam before implementing your own handler.

Boîtes de dialogue créées via d’autres packagesDialogs created through other packages

Vous pouvez implémenter votre propre solution pour les boîtes de dialogue qui résident en dehors de msenv.You can implement your own solution for dialogs that reside outside msenv. Pour une classe de boîte de dialogue partagé dans votre VSPackage, envisagez de déplacer le bouton à la barre de titre ou l’implémentation d’un gestionnaire sur chaque boîte de dialogue.For a shared dialog class in your VSPackage, consider moving the button to the title bar or implementing a handler on each dialog. Le code suivant est un squelette d’une implémentation pour vous aider à bien démarrer :The following code is a skeleton of an implementation to help you get started:

struct DLGPROCITEM  
{  
    FARPROC proc; // The info used to create the dialog.  
    DLGPROCITEM* procPrev;  
};  

DLGPROCITEM* g_dlgProcStack = NULL;  

// A dialog starter/wrapper function is used to push the new  
// dialog proc to the top of our dialog proc stack.  

int SomeDialogStarterFunction(hinst, id, proc, etc)  
{  
    if (g_dlgProcStack == NULL)  
    {  
        g_dlgProcStack = new DLGPROCITEM;  
        g_dlgProcStack->procPrev = NULL;  
    }  
    else  
    {  
        DLGPROCITEM* procItem = new DLGPROCITEM;  
        g_dlgProcStack->procPrev = g_dlgProcStack;  
        g_dlgProcStack = procItem;  
    }  
}  

// Pop this dialog proc off the dialog proc stack.  

DialogBoxIndirectParam...(...)  
{  
    DLGPROCITEM* procItem = g_dlgProcStack->procPrev;  
    delete g_dlgProcStack;  
    g_dlgProcStack = procItem;  
}  

// A wrapper dialog procedure will allow us to capture the  
// SC_CONTEXTHELP button on the title bar from Windows and  
// forward it as a simple WM_HELP message back to the dialog.  

INT_PTR CALLBACK DialogPreProc(HWND hwndDlg, UINT uMsg,  
    WPARAM wParam, LPARAM lParam)  
{  
    if (uMsg == WM_SYSCOMMAND && wParam == SC_CONTEXTHELP)  
    {  
        uMsg = WM_HELP;  
        wParam = 0;  
        lParam = 0;  
    }  
    return CallWindowProc((WNDPROC)g_dlgProcStack->proc,  
        hwndDlg, uMsg, wParam, lParam);  
}  
Boutons d’aide dans le code managéHelp buttons in managed code

Il suffit de substituer le comportement par défaut de la fenêtre titre barre aide du bouton dans le code managé.Overriding the window title bar Help button's default behavior is easy in managed code. Voici une application de démonstration complet qui illustre ce comportement.Below is a complete demo application that demonstrates this behavior. En bref, vous devez remplacer votre formulaire WndProc (méthode) et les incendies puis désactiver F1 Aide demandes quand un SC_CONTEXTHELP message est intercepté.In essence, you need to override your form's WndProc method and then fire off F1 help requests when an SC_CONTEXTHELP message is intercepted.

using System;  
using System.Windows.Forms;  

public class HelpForm : Form  
{  
    private const int SC_CONTEXTHELP = 0xF180;  
    private const int WM_SYSCOMMAND = 0x0112;  

    public HelpForm()  
    {  
        this.ClientSize = new System.Drawing.Size(300, 250);  
        this.HelpButton = true;  
        this.MaximizeBox = false;  
        this.MinimizeBox = false;  
        this.Name = "HelpForm";  
        this.Text = "Help Form";  
    }  

    protected override void WndProc(ref Message m)  
    {  
        if (m.Msg == WM_SYSCOMMAND && SC_CONTEXTHELP == (int)m.WParam)  
            ShowHelp();  
        else  
            base.WndProc(ref m);  
    }  

    private void ShowHelp()  
    {  
        MessageBox.Show("F1 Help goes here.");  
    }  

     [STAThread]  
    static void Main()  
    {  
        Application.EnableVisualStyles();  
        Application.EnableRTLMirroring();  
        Application.Run(new HelpForm());  
    }  
}  

Voir aussiSee Also

Polices et mise en forme pour Visual Studio Fonts and Formatting for Visual Studio
Mise en page pour Visual Studio Layout for Visual Studio
Notifications et progression pour Visual StudioNotifications and Progress for Visual Studio