Convenções
Para melhorar o entendimento do usuário, certas convenções de formatação são usadas neste documento. As convenções de formatação usadas estão listadas na tabela abaixo.
Elemento | Notação | Descrição | Saída |
|---|---|---|---|
Ênfase geral | No espaço de trabalho Programa | Para destacar ou realçar certos elementos de texto. | Texto em Negrito |
Itens da Interface Gráfica do Usuário (GUI) | Selecione o botão Função . | Qualquer referência aos itens encontrados na tela da interface GUI (por exemplo, botões de comando, nomes de ícones e nomes de campos). | Texto em Negrito |
Caminho da Interface Gráfica do Usuário (GUI) > | Em geral, na parte superior da GUI. | Recurso de navegação que mantém registro da localização na GUI. | Por exemplo: Controlador > Programa > Editar |
Entrada do usuário | Insira uma Descrição do programa. | Qualquer texto digitado pelo usuário. | Texto em Negrito |
Nomes de arquivo | Insira um Nome de Arquivo para a exportação. | Arquivos exportados ou importados para o sistema. | Texto em Negrito e Itálico |
Nomes de variáveis e de parâmetros | Insira um Nome para a exportação. | Nomes de variáveis e de parâmetros (sem os valores). | Texto em Itálico |
Valores de variáveis e de parâmetros | Insira um VALOR para a exportação. | Valores de variáveis e de parâmetros. | Texto em MAIÚSCULAS EM NEGRITO |
Saída do sistema | Client.Domain.Models.ExportImportConfiguration | Qualquer saída de texto do sistema. | Texto em Espaçamento uniforme |
Links externos | Links para sites externos que contêm informações relacionadas ao conteúdo ou assunto, que podem incluir:
| Texto selecionável para sites externos | |
Links de documentações internas |
Se disponíveis, esses links serão apresentados embaixo do texto. | Texto selecionável para conteúdo interno |
