Especificações do produto - Consistência do layout e do tratamento editorial
Atividades relacionadas (especificações do web site)
As atividades abaixo são relacionadas à criação das especificações de atualização de web sites e estão numeradas de acordo com o sequenciamento de atividades do lançamento do web site, da Estrutura Analítica de Projeto proposta neste site:
■ N1. Agrupar e selecionar informações sobre a atualização e produção de conteúdo produzidas nos registros de projeto e nas decisões tomadas em reuniões ou via emails e conversas.
■ N2. Criar e atualizar gradual e constantemente as especificações ao longo do projeto, de forma a documentar todas as decisões sobre a atualização do conteúdo tomadas em cada etapa. ► Exemplo (.doc zipado, 113Kb)
É comum os colaboradores acharem, durante o projeto, que parar o trabalho para escrever especificações é perda de tempo. Mas algum tempo depois do lançamento do projeto, as especificações se revelam uma fonte valiosa de referências práticas para a tomada de decisões em situações novas.
Na criação do documento é importante:
◊ Considerar as características do público que vai ler e usar a documentação. Algumas pessoas preferem um formato "como fazer", mais pragmático, simples de seguir. Outros demandam explicações mais detalhadas sobre configurações técnicas e sobre o funcionamento do sistema. Para atendê-los, eventualmente pode ser necessário escrever um documento para a equipe técnica e outro para a equipe editorial, que têm necessidades e perfis bastante diferentes.
◊ Estruturar o texto em pequenos módulos, mais fáceis de redigir, consultar e atualizar, bem como de reutilizar em outros módulos. Textos em tom coloquial mas não muito informal, não comprometem a confiança no conteúdo.
◊ Usar linguagem simples e clara, sem jargões, mesmo para o público especializado. A cada primeira vez que uma sigla for citada, esta deve ser inteiramente descrita por extenso.
◊ Incluir um índice, para que o usuário encontre rapidamente o assunto de seu interesse.
◊ Embora não muito comum nestas publicações, incluir exemplos e imagens para facilitar a compreensão dos conceitos. Exemplos, analogias e exposição de casos ilustrados por imagens (em gráficos, tabelas), facilitam a demonstração de procedimentos, a compreeensão das informações e aumentam o interesse do leitor.
■ N3. Realizar diversas revisões antes da publicação. Embora esta atividade possa parecer evidente, é muitas vezes negligenciada. Diversas revisões aumentam a qualidade do texto, reduzem a incidência de erros de digitação e aumentam as chances das informações serem úteis para quem as consulta.
Neste processo de releitura, é importante o redator se colocar no lugar de quem está lendo as especificações, ou então consultar um futuro leitor para verificar as suas reações ao ler o texto.
■ N4. Distribuir o arquivo impresso em formato de uso universal não editável (PDF, por exemplo). No caso de um ambiente participativo, a publicação de um wiki que possa ser sempre atualizado funciona em conjunto com a versão inicial impressa ou em PDF, para o registro das melhores práticas que vão aos poucos sendo implementadas no veículo ou ambiente web.
■ N5. Treinar a equipe para aplicar e revisar as especificações. A apresentação presencial, com reuniões e discussões, é tão necessária quanto a disseminação do documento escrito.
■ N6. Designar o(s) responsável(eis) pela atualização e distribuição das especificações para:
◊ A alteração, quando necessário.
◊ A adaptação a novas situações e necessidades.
Caso as especificações sejam publicadas em wiki, a atualização é colaborativa e a responsabilidade é compartilhada pelos integrantes da equipe de atualização e suporte.
■ N7. Criar um documento com opiniões/anotações sobre alterações estruturais para uma reestruturação futura mais abrangente do canal.
Quando algumas situações demandam a realização de alterações estruturais no projeto, que não podem ser implementadas devido à sua abrangência, devem ser registradas para consideração em um futuro projeto de redesenho.
Outras atividades da elaboração das especificações
■ Se o manual for feito por empresa externa, combinar como será a participação da equipe interna de atualização e suporte na elaboração e aprovação. Quanto maior a atuação da equipe interna, mais chances do manual ser efetivamente utilizado e atualizado.
■ Entrevistar a equipe de atualização de conteúdo, desenvolvimento de interfaces e serviços, manutenção e atendimento ao cliente e gestores, para examinar as suas dúvidas e as suas demandas em relação ao manual.
■ Consultar outros manuais ou especificações editoriais e de layout, para avaliar os tópicos abordados e o modo de tratamento do conteúdo. A consulta é um trabalho crítico e referencial que ajuda o aperfeiçoamento do produto.
■ Propor uma lista de itens a desenvolver nas especificações e submeter esta lista aos clientes internos, para evitar o desenvolvimento de conteúdo desnecessário.
■ Apresentar formalmente as especificações para o público interno, para que todos os integrantes da equipe (mesmo os que não lerem as especificações) tenham conhecimento dos seus aspectos mais importantes.
Mais informação sobre a elaboração das especificações do web site
► Tips for writing good documentation, de Audrey Watters (ReadWriteWeb, acesso em 21.8.2010)
► Help! User documentation that works, de Georgina Laidlaw (SitePoint, acesso em 3.7.2010)
► Using wikis to document UI specifications, de Peter Gremett (Boxesandarrows, acesso em 24.7.2009)
► Beyond specs, de Matthew Barnett (Projects@Work, acesso em 26.8.2008)
► Visual language - Design guidelines for the widening of page templates across bbc.uk.uk - especificações de design dos sites da BBC
► Four to the core (Projects@Work, acesso em 14.8.2008)
