Esta é a tradução do artigo "Quality Tips for Webmasters " de autoria de Dan Connolly publicado no site do W3C.
1. A versão oficial e original, em inglês, deste artigo, encontra-se em: http://www.w3.org/QA/Tips/ e os seus direitos são conforme:
Copyright ©2002 W3C® (MIT, INRIA, Keio), Todos os direitos reservados. São aplicáveis as disposições do W3C relativas a responsabilidade, marcas, uso de documentos e licença de software
2. A única versão oficial deste documento é a versão em língua inglesa que se encontra no sítio do W3C.
3. O presente documento traduzido para a língua portuguesa do Brasil, pode conter erros de tradução.
Este documento foi traduzido em 02 de janeiro de 2005 por: Maurício Samy Silva e encontra-se hospedado no seu sítio "CSS para WebDesign" em http://www.maujor.com/
A traduçao foi feita somente para este documento, vale dizer, as páginas remetidas pelos links aqui indicados, estão em sua versão original em língua inglesa. Excetuam-se os links para as 17 páginas com a descrição de cada uma das dicas, que também foram traduzidas. Naquelas páginas no menu de navegação à direita, você encontra um link nomeado "Índice das dicas" que aponta para esta página inicial.
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.
alt 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.
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 (<blockquote>, <q>). É de boa prática complementar uma citação normativa com explicações adicionais quando necessário.
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.
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.