A elaboração de conteúdo baseado em tópicos tem sido um dos pilares do desenvolvimento de informações técnicas desde que começamos a desenvolver sistemas de ajuda. Aprendemos rápido o suficiente que não poderíamos simplesmente desmembrar os livros já existentes em tópicos de ajuda, apenas transformando cada título e subtítulo em novas paginas de help. A estrutura narrativa original das informações não fazia mais sentido e nem ajudava os usuários a encontrarem exatamente o que eles precisavam. Precisávamos repensar os tipos de informações que nossos sistemas de ajuda deveriam incluir e criar um novo conjunto de padrões para este desenvolvimento. O resultado foi a elaboração de conteúdo baseado em tópicos.

A elaboração de conteúdo em tópicos permite que redatores criem módulos de informação que, por si só, tenham significado para os usuários. Cada tópico responde a uma questão: "Como eu...?" "O quê é...?" "O que deu errado?" Cada tópico tem um título que identifica sua finalidade e contém conteúdo suficiente para que alguém comece e termine uma tarefa, entenda um conceito básico, ou encontre referência para uma informação crítica. Cada tópico contém um conjunto básico, definido cuidadosamente, das unidades de conteúdo necessárias, e pode incluir outros conteúdos opcionais. À medida em que desenvolvedores de informação aprendem a elaborar conteúdo em tópicos e a seguir convenções de redação de forma consistente, ganhamos a habilidade de oferecer informações escritas por diferentes profissionais que parecem semelhantes aos olhos dos usuários.

Além de conteúdos baseados em tópicos terem se tornado a norma para sistemas de ajuda bem projetados, arquitetos da informação aprenderam que formular tópicos estruturados de forma consistente facilita a legibilidade e o acesso à informação mesmo em estruturas tradicionais e mais lineares de livros. Os leitores são capazes de identificar tópicos baseados em tarefas em seções e capítulos porque as tarefas são semelhantes e contém as mesmas unidades essenciais de conteúdo. Os leitores aprendem que informações básicas e conceituais estão sempre localizadas na mesma posição no sumário em relação às tarefas. Os leitores acabam dependendo de seções padronizadas de referência contendo detalhes estruturados de forma semelhante para facilitar a consulta.

Os tipos de informação básicos do DITA suportam as estruturas por trás da maioria das informações técnicas bem projetadas. Qualquer organização que siga melhores práticas em arquitetura de informação achará que a estrutura básica do DITA se encaixa bem às suas necessidades. Mas esta mesma estrutura básica também nos desafia a sermos cada vez mais disciplinados em estruturar a informação de acordo com um conjunto de regras cuidadosamente definidas. A vantagem de se ter uma estrutura de informação disciplinada desta forma é a apresentação consistente da informação, que ajuda a ganhar a confiança do leitor e simplifica sua tarefa de saber como navegar e como usar sua informação.

Elaborar conteúdo como tópicos estruturados possibilita que você entregue informação a seus usuários de forma sofisticada e poderosa. Você descobrirá benefícios que reduzirão seu custo de desenvolvimento e seu tempo para entrega, ao mesmo tempo em que possibilitarão aumentar o valor entregue a seus clientes:

• Tópicos estruturados contêm apenas a informação necessária para se compreender um conceito, realizar um procedimento, ou procurar um conjunto de informações de referência.

• A elaboração de conteúdo baseada em tópicos estruturados garante a consistência na apresentação de informações similares.

• Tópicos podem ser revisados por especialistas no assunto em questão assim que estiverem prontos. E só precisam ser revisados uma vez, mesmo que apareçam em vários produtos, reduzindo a sobrecarga sobre os revisores.

• Tópicos podem ser traduzidos antes que volumes inteiros estejam completos, reduzindo o time to market para consumidores globais. Tópicos em vários idiomas podem ser combinados em produtos específicos para cada região sem tempos e despesas extras de publicação eletrônica.

• A integração de tópicos em múltiplos produtos pode ser automatizada, reduzindo tempos e custos de produção.

• Tópicos estruturados de forma consistente são mais fáceis de serem reutilizados em múltiplos produtos.

• Tópicos são mais fáceis de serem atualizados imediatamente, em vez de ter que esperar pela disponibilidade da próxima versão de um conjunto completo de documentos.

• Tópicos estruturados de forma consistente ajudam os usuários a construirem um modelo mental sólido dos tipos de informação que você está apresentando.

• Tópicos estruturados de forma consistente ajudam os usuários a navegarem mais rapidamente até a informação de que eles precisam.

Se um de seus objetivos é usar tópicos de informação em múltiplos produtos, você precisa montar um repositório de tópicos claramente definidos e em conformidade com seu conjunto padrão de tipos de informação. Seu repositório também se caracteriza pelos atributos de metadados que você associa com seus tópicos.

O DITA fornece uma estrutura básica para esta padronização que pode ser usada como ponto de partida. O DITA também lhe dá a possibilidade de expadir esta estrutura básica caso você precise acomodar necessidades e informações específicas suas e de seus clientes.

Definindo tipos de informação para seus tópicos

Se suas informações são como as da maioria da produzidas pela indústria de informação técnica, você deve ter uma grande diversidade de estruturas, especialmente se suas informações estiverem embutidas em narrativas e em seções e capítulos de livros. Seu primeiro trabalho deve ser o de montar um inventário de seu conteúdo de forma a identificar sua abrangência e diversidade.

Na maioria dos casos você identificará muitas tarefas, contendo instruções passo-a-passo para que determinado objetivo possa ser alcançado. A predominância de tarefas nas informações técnicas é o motivo do DITA apresentar o tipo tarefa (task) como um de seus três tipos básicos.

Junto das tarefas, você deve encontrar consideraçoes gerais, descrições e informações conceituais que explicam "o que é" alguma coisa. O DITA chama estas informações de suporte de conceitos (concepts). Você também encontrará tabelas, listas, diagramas, fluxos de processo, e outras informações que podem ser chamadas de referências (referentece), informações que ninguém quer memorizar, mas que devem ser fáceis de serem localizadas.

Após terminar de inventariar seu conteúdo, você deve analisar cuidadosamente os três tipos básicos de informação fornecidos com o DITA. A estrutura padrão para tarefa, conceito e referência é apresentada na especificação DITA. Avalie como seu conteúdo pode ser acomodado na estrutura padrão. Na maioria dos casos, seu conteúdo deve se adequar facilmente à estrutura padrão do DITA.

As dificuldades que você encontrar podem estar relacionadas mais à própria diversidade de seu conteúdo do que aos tipos de informação do DITA. Alguns conteúdos em seu inventário podem estar em desconformidade com suas próprias convenções. Geralmente este conteúdofoi escrito há tempos atrás por pessoas que já saíram da organização, ou foi influenciado por especialistas no assunto que queriam o conteúdo do seu jeito ao invés de seguindo as convenções de redação da equipe.

Nossa recomendação é focar na estrutura essencial por trás do seu conteúdo e não se preocupar com as idiossincrasias e acidentes individuais de redatores específicos ao longo dos anos. Se encontrar uma estrutura estranha em uma tarefa, por exemplo, pergunte-se se esta estrutura é a melhor forma de apresentar a informação ao usuário, ou se a tarefa pode ser reescrita conforme a estrutura de um dos tipos básicos de informação do DITA. Na maioria dos casos você perceberá que o padrão é a melhor solução.

Um dos problemas mais comuns que você deve identificar nos conteúdos que examinar são estruturas misturadas. Tarefas que começam com longas discussões sobre considerações gerais. Conceitos que acabam incluindo procedimentos passo-a-passo. Tabelas com materiais de referência que acabam com conceitos em notas de rodapé ou tarefas incorporadas em algumas células.

Apesar do DITA prever a possibilidade de tipos misturados de informação, nos não recomendamos o uso deles. Considere que ao separar as informações cuidadosamente e com o máximo de rigor, com base em tipos de informação consistentes, você terá uma informação que pode ser apresentada ao usuário com mais flexibilidade e mais dinamicamente. Se os usuários quiserem saber os passos de uma tarefa, não precisarão passar por considerações que eles ainda não querem conhecer. Você pode orientá-los até esta informação conceitual através de referências ou links ao invés de embutí-las diretamente na tarefa.

Agrupando suas informações em tipos bem definidos, em vez de combiná-las aleatoriamente, você ganha flexibilidade na distribuição delas às pessoas que mais precisam. Você também consegue fazer com que os relacionamentos entre grupos de informação se tornem mais óbvios. Se você acredita que os usuários terão melhores resultados se lerem informações conceituais antes de realizarem determinada tarefa, com o uso de links relacionados aos tópicos você pode garantir que eles tenham conhecimento da existência destas informaçõe e dos benefícios da revisão prévia de conceitos e considerações.

Criando novos tipos de informação

Apesar de considerarmos que a maioria das informações técnicas encaixa-se perfeitamente nos tipos básicos de informação do DITA, reconhecemos que você pode ter algum tipo especial de informação que não possa ser acomodado pelas unidades básica de conteúdo, ou que você queira nomear estas unidades de conteúdo com algum tag XML mais descritivo ou adequado. Nestes casos, você precisará desenvolver especializações.

Considere um exemplo na indústria de semicondutores. Uma grande quantidade de informações detalhadas do projeto de um chip é contida em um tipo de informação chamado de descrição de registrador. Apesar de uma descrição de registrador poder ser considerada como uma referência, ela contém alguns conteúdos muito específicos e detalhados. Através de uma especialização do tipo de informação referência, você pode construir um novo tipo descrição de registrador que padroniza o conteúdo com elementos XML apropriados, auxiliando redatores e provendo metadados adicionais para facilitar futuras buscas. Várias oportunidades para especialização podem surgir de seu conteúdo. Mas tenha o cuidado de esgotar todas as possibilidades dos tipos básicos de informação antes de buscar pelas diferenças.

Quanto mais diferenças você apresentar a redatores e leitores, maiores as oportunidades para confusões. Com muitas opções de tipos de informação, maior a possibilidade de um desenvolvedor de informação fazer uma escolha errada. Com muitas diferenças sutis na apresentação da informação, maior a possibilidade do usuário ficar confuso quando não conseguir localizar o conjunto de conteúdo padrão que ele esperava encontrar.

Esta discussão sobre elaboração de conteúdo baseada em tópicos foi retirada de
Introduction to DITA: A Basic User Guide to the Darwin Information Typing Architecture, da Comtech Services, Inc.

See the source English version of this page.