Dicas de garantia de qualidade para Webmasters
Este artigo tem por objetivo motivar os desenvolvedores Web para o uso do serviço de validação de HTML como um veículo de treinamento. Daremos dicas para webmasters relativas aos itens de garantia de qualidade preconizados pelas tecnologias do W3C? tais como HTML, CSS, HTTP.
Cada dica está sumariamente descrita em um texto que se constitui em link para uma explicação detalhada.
Dicas de garantia de qualidade
* : o elemento mais importante para a qualidade de um website
* Não use "Clique aqui" para texto de link
* Use redirecionamento standard: não tire a função do botão "back"
* Use h1 para os cabeçalhos de primeiro nível
* Use o atributo alt
* Não esqueça do doctype em seu documento
* Use s no seu documento
* Se especificar cor, especifique para tudo
* Atenção com os tamanhos de fontes
* Use formatação internacional para datas
* GIF ou PNG?
* Use cabeçalhos para estruturar seus documentos
* Escolha criteriosamente suas URIs
* Administrando as URIs
* Além da validação
* Nomeie classes semanticamente
* Listas não ordenadas: mais do que marcadores
* Defina URIs legíveis (Novo proposta "draft" dica em fase de recebimento de feedback) NT: Este documento será traduzido quando tornar-se oficial
Como escrever e propor uma dica
Qualquer um é bem-vindo para submeter uma nova dica para ser acrescentada a este documento.
Leia as dicas de garantia de qualidade que já foram submetidas. Se você achar que uma dica não está clara e desejar propor modificação, primeiro pesquise nas referências constantes da dica, pois pode ser que seu ponto de vista já tenha sido discutido em www-qa@w3.org mailing-list.
Escreva sua proposta de dica de garantia de qualidade usando um Template para dicas de garantia de qualidade .
Após ter escrito sua dica envie um e-mail para a lista www-qa@w3.org com o arquivo contendo a dica em anexo.
Durante a fase de revisão um membro do time do W3C? QA publicará sua dica na página Quality Tips for Webmasters com o status de rascunho. A dica permanecerá durante 2 semanas em revisão na lista de e-mail.
Passado este período de revisão o autor da dica incorpora o feedback recebido e envia uma versão revisada para www-qa@w3.org ; O time do QA checa a incorporação do feedback no documento e este segue para validação da produção.
Dicas para escrever dicas
*
Comece com um título simples e atrativo. O interesse das pessoas em ler a dica depende da motivação que o título desperta.
*
Qual é o objetivo da dica? Deixe logo no início e bem claro, qual é o objetivo da dica. Faça uma breve introdução e desperte a curiosidade das pessoas em continuar lendo.
*
... Antes de começar a descrever a dica lembre-se: seja conciso. Isto é difícil, porque você não tem idéia do contexto de onde vem seus leitores, escreva textos curtos.
*
As dicas são pequenas informações destinadas a fornecer subsídios complementares e esclarecer, elas não tem caráter normativo nem são especificações rigorosas a seguir. As dicas devem sugerir e justificar e nunca ter caráter impositivo ao leitor.
"Deve" pode ser usado em uma dica quando for uma transcrição de uma especificação normativa. Ao usar o termo "deve" em um texto, deixe bem claro tratar-se de uma citação, através de uma marcação apropriada (
, ). É de boa prática complementar uma citação normativa com explicações adicionais quando necessário.
* É também uma boa prática, fazer referências a outros documentos que contenham textos correlatos ao da dica.
Coloque (não em demasia) no final da dica, referências com uma breve explicação, para documentos onde as pessoas possam aprofundar a leitura no assunto da dica.
Ao fazer referência a uma especificação normativa, explique os acrônimos ou escreva por extenso usando se possível, marcação apropriada.
Todo
Nota do tradutor: Esta seção do documento trata de uma lista de tarefas a cumprir, para propor uma dica ao W3C? . Por ser um procedimento muito específico e com instruções pormenorizadas nos links indicados e em ingles, julgo fora do escopo desta tradução e em consequência deixo de traduzir. Àqueles que desejarem propor uma dica sugiro consultar o documento original no site do W3C? .
Done:
: o elemento mais importante para a qualidade de um website
O elemento em HTML foi projetado para descrever um pequeno texto no documento a ser usado:
* na barra de títulos da janela do documento
* em listas de favoritos (bookmarks)
* nas listas de resultados, pelos sites de busca
Um bom título
Assim, não se esqueça de dar um bom título ao seu documento:
não muito curto
"Seção 1" não diz nada quando inserida em uma lista com resultados de uma busca. Seção 1 do quê?. Melhor seria: Secao 1 do Guia da Musica Moderna ou, melhor ainda Time Frame (Guia da Musica Moderna, Secao 1)
não muito longo
Está entre 60 e 80 a quantidade de caracteres que podem ser mostrados em uma barra de títulos, menu, etc.; você poderá fornecer um título mais extenso e detalhado no cabeçalho de nível mais alto do documento, por exemplo:
Guia da Musica Moderna - Secao 1: Em que epoca teve início o ciclo da musica moderna, Musica erudita?