Deve ser adotado o mesmo padrão do HIG da Alterdata.
No caso, de manuais produzidos na ferramenta Confluence deve-se adotar a letra padrão da mesma.
Convenções Tipográficas
Para melhor organização visual da leitura, utilize a tabela abaixo para saber qual tipo de realce utilizar em cada situação:
Elemento | Realce | Exemplo |
---|---|---|
Chamadas de API | Nenhum | sqlurlog |
Título de livros, CDs, Documentos | Itálico | Veja o InfoDBase Reference... |
Exemplos de código | Monoespaço | Digite o seguinte comando: xclient userid pwd import |
Comandos | Negrito | O comando exit não está habilitado. |
Controles e caixas de seleção | Negrito | Marque a checkbox New file. |
Diretórios | Monoespaço | O arquivo XML está no diretório c:\temp |
Entrada de dados | Monoespaço | Digite exit e aperte Enter. |
Entrada de campos | Negrito | No campo Table name, digite... |
Nomes de arquivos | Monoespaço | Abra o arquivo readme.txt |
Nomes de funções | Negrito | A função Digits processa... |
Objetos da interface | Nenhum, todas em caixa alta | Clique no ícone System menu. |
Teclas | Negrito | Pressione ALt+F1 |
Nomes de Menus e opções | Negrito | Para criar um novo projeto, clique em Project / New. |
Mensagens de texto | Monoespaço | A mensagem Action complete informa que... |
Novos termos (quando definidos) | Monoespaço | Uma Hierarquia é uma... |
Parâmetros de variáveis | Itálico | Defina userid para o seu sobrenome... |
Nomes de Janelas e Assistentes | Itálico | Na janela Project... |
Texto de Exemplo | Monoespaço | Por exemplo, acess denied indica que...
|