Revision of História do DITA from Sat, 2009-07-11 00:10

 

A história do DITA é a história das suas várias características importantes - modularidade, redação estruturada, tipologias de informação, separação entre conteúdo e apresentação, origem única, minimalismo, informações baseada em tópicos, informações orientadas por tarefas, reuso de conteúdo, processamento condicional, facilidade de localização de conteúdo, multicanal, publicação de componete, usabilidade, consistência, orientação a objetos, herança, especialização, XML simplificado.

Se você não compreende todas essas características do DITA, pode ser que você não tenha analisado de forma apropriada o DITA Business Case - para sua organização, ou para você mesmo caso seja um redator profissional.

Você não precisa saber como fazer todas essas coisas para usar DITA, mas se não houver ninguém na sua organização que saiba o porquê de usá-las, isso pode ser um problema. Se você já estiver fazendo algumas dessas coisas, você irá querer saber como elas são incorporadas pelo DITA.

Antes de 1960

 

O historiador da comunicação técnica, R. John Brockmann, identifica através de pesquisas que esforços para a documentação de produtos vêm sendo realizados há séculos. Ele descobre que algumas das idéias mais modernas relacionadas à documentação já estavam presentes nos trabalhos dos responsáveis pela criação, documentação e comercialização de tecnologias manufatureiras logo após a Guerra Revolucionária Americana. ( From Millwrights to Shipwrights to the Twenty-First Century: Explorations in a History of Technical Communication in the United States)

Os computadores atuais, com suas interfaces gráficas espetaculares, permitem-nos apresentar imagens virtuais animadas, mesmo modelos 3-D para ilustrar máquinas complexas. Mas esse não é a rotina do dia-a-dia de um redator técnico. Animações em Flash e computer-aided design (CAD) demandam habilidades mais próximas às de uma equipe de projetistas de jogos eletrônicos que às de um redator técnico solitário ou de um revisor.

Brockmann descobriu que imagens bidimensionais eram uma parte fundamental da documentação técnica no século XVIII.  E idéias modernas como modularidade já existiam na forma de documentos que eram estruturados como um conjunto de cartões montados como um livro. Também descobriu que trabalhos antigos eram muito centrados no usuário e orientado por tarefas, e que tiravam vantagem de conhecimentos que já estavam disponíveis aos usuários.

Parece que a maior parte das mudanças na documentação técnica atual é a influência direta do computador, e por algumas razões óbvias:

  • Documentação de software, incluindo ajuda online, tornou-se o paradigma dos redatores técnicos atuais.
  • Desde o surgimento da publicação eletrônica, dependemos radicalmente do computador para nos auxiliar na preparação de nossa documentação.
  • Teóricos da documentação de computadores pensaram estar em um novo campo e simplesmente reinventaram práticas em uso há muito tempo para explicar máquinas simples.


Anos 1960 e 70 - Aprendizado Programado, STOP, QRC, Organizadores Avançados, Mapeamento de Informações

 

Em Harvard nos anos 1960, o behaviorista B.F.Skinner previa que os computadores se tornariam as "máquinas que ensinariam". Suas idéias de "aprendizado programado" ainda influenciam os modelos atuais de eLearning. Seu trabalho requeria que conhecimetno fosse quebrado em blocos.

Hughes STOP - (Sequential Thematic Organization of Publications), ou Organização Temática Sequencial de Publicações, defendia uma abordagem baseada em storyboards apresentados em duas páginas. Um grande gráfico em uma página, com legendas claras, ilustra o texto explicativo principal na página oposta.

A marinha norte-americana publicou o método Quick Reader Comprehension (QRC), ou Leitura de Compreensão Rápida, em 1961. O método explicitava a importância de uma documentação modular que pudesse ser reestruturada e reusada para fins diferentes, talvez a primeira menção de Reuso.

David Ausubel foi o primeiro a propor Organizadores Avançados em 1960. Eram versões formais de um professor explicando aos alunos o que seria dito, depois dizendo, e por fim contando o que foi dito, um sumário, no método clássico de aprendizado em três etapas. Ausubel defendia imagens e títulos e subtítulos claros que revelassem a estrutura de um documento.

Em meados dos anos 60, Robert Horn (vencedor de um ACM SIGDOC Lifetime Achievement Award for Documentation) desenvolveu técnicas de Mapeamento de Informações e fundou uma empresa de mesmo nome (Information Mapping). "Tipos de Informações" comuns foram identificadas em dúzias de tipos de documentos padrões, como manuais de usuário, manuais de políticas e procedimentos, relatórios anuais etc. A identifiacção de tipos padronizados de informação está no coração do DITA (Darwin Information Typing Architecture).

No fim dos anos 60, Charles Goldfarb, Edward Mosher e Raymond Lori (cujas iniciais foram utilizadas por Goldfarb para formar o acrônimo GML) criaram para a IBM a Generalized Markup Language para documentos. Em 1974, a GML tornou-se SGML, com a ajuda de Yuri Rubinsky e outros. SGML foi, por vários anos, a linguagem padrão utilizada para documentos estruturados na indústria militar, aero-espacial e em grandes companhias de software. Ela se tornou a base da especificação DocBook.

Em 1973, David Wooley na Universidade de Illinois desenvolveu PLATO Notes, um tipo de painel de mensagens. Tópicos eram postados e usados como a base de uma comunidade online que dava suporte ao sistema de compartilhamento de tempo PLATO. Ray Ozzie usou o PLATO Notes quando era um estudantes em Illinois e em 1990 criou o Lotus Notes, incluindo algumas funcionalidades do PLATO Notes.

 

Anos 1980 - SGML, Orientação por Tarefas na IBM, Publicação Eletrônica, Macintosh Documentation Guidelines e Ajuda Online

 

Em 1980, o comitê de padronização da ANSI para processamento de informações publicou o primeiro rascunho do padrão SGML. SGML foi, por vários anos, a linguagem padrão utilizada para documentos estruturados na indústria militar, aero-espacial e em grandes companhias de software. Ela se tornou a base da especificação DocBook.

Em 1981, uma equipe na IBM conduzida por Fred Bethke atentou para uma nova "orientação por tarefas" na documentação de softwares de computadores. O relatório que publicaram, IBM Improving usability of publications (1981), contrastou documentos que refletiam a arquitetura dos sistemas de software. Eles perceberam que usuários tinham que entender previamente o software para encontrar a ajuda que precisavam. Usuários menos experiente ficavam perdidos. Uma outra abordagem era a documentação orientada por perfis de usuários. Mas a nova idéia para Bethke era a orientação por tarefas, que se preocupa com as tarefas que as pessoas realizam com mais frequência nos programas de computador, indepentemente de suas funções, e foca na informação necessária para realizar tais tarefas.

Em 1981, o Interleaf introduziu a publicação eletrônica para a construção e composição de documentos. Incluía processador de textos, gráficos, diagramas, tabelas, equações, edição de imagens e layout automático de página. O Interleaf gerava índices e tabelas de conteúdo para livros automaticamente, e incluia funcionalidades para processamento condicional de conteúdo.

Em 1983 O laboratório da IBM em Santa Teresa publicou Producing Quality Technical Information (atualmente indisponível), orientações para a redação técnica, a maior parte específica para a IBM e para a documentação de software. A equipe de redatores incluía Fred Bethke, cujo artigo anterior IBM Publishing Guidelines já havia estabelecido a importância da orientação por tarefas. Eles identificaram sete características de qualidade: orientação por tarefas, organização, pontos de entrada, clareza, comunicação visual, precisão e completude.

Em 1984, a nova Apple Macintosh foi uma revolução na interface de usuário dos computadores e uma revolução similar para a documentação de computadores. A interface para os documentos passou a ser WYSIWYG (what you seeis what you get, ou "o que você vê é o que você tem", ao imprimir o documento). Nascia a Publicação Eletrônica economicamente viável. O primeiro programa DTP (publicação eletrônica), o MacPublisher que custa à época US$99, foi criado por Bob Doyle, no ano do Mac. Aldus (que mais tarde se tornaria Adobe) Pagemaker surgiu em 1985. Estas ferramentas levaram os redatores técnicos a inserirem estilos em seus documentos e mesmo a diagramar o conteúdo na página. Neste momento o pensamento DTP torna-se o maior inibidor do reuso de conteúdo, misturando o conteúdo com a apresentação.

O novo Macintosh Documentation Guidelines trazia três seções. Uma visão geral de Aprendizado, com tutoriais que introduziam novos conceitos e funções, uma ampla seçãosobre Uso com descrições de como realizar tarefas, e uma seção de Referências do programa. Neste momento, livros bem escritos sobre computadores (por exemplo os publicados pela O´Reilly) passam a apresentar Aprendendo (por exemplo, Aprendendo PHP), Usando (por exemplo, Programando PHP), e volumes de Referência Completa.

Observe como Aprendendo, Usando e Referência se relacionam perfeitamente com os três tipo de informação DITA especificados a partir da estrutura básica de Tópico DITA - Conceito (Concept), Tarefa (Task) e Referência (Reference). E note que seção "Usando" da Macintosh era orientada por tarefas, exatamente como a IBM recomendava.

Em 1984, a Lotus apresentou sua planilha eletrônica 1-2-3, que mais tarde foi o primeiro software a usar a tecla F1 para invocar uma ajuda online baseada em tópicos e sensível ao contexto.

Em 1986, o FrameMaker foi apresentado no Sun OS. Este programa DTP foi projetado para documentos extensos, como livros. Tornou-se muito popular entre redatores técnicos profissionais e por US$2500 era um grande competidor para o, bem mais caro, sitema da Interleaf.

Em 1987, Ralph Walden escreveu o primeiro sistema de ajuda online da Microsoft, o QuickHel, para o MS-DOS. Mais tarde, ele viria a desenvolver o WinHelp e o HTML Help.

Em 1986, R. John Brockmann publicou o artigo Writing Better Computer User Documentation (Escrevendo Melhores Documentações para Usuários de Computadores). Brockmann descreveu as mudanças necessárias para se passar da documentação em papel para a documentação online. Ele destacou a nova abordagem orientada por tarefas, que limita a informação ao que é necessário para a realização de uma única tarefa, considerando que o usuário pode encontrar outras informações genéricas em algum outro lugar, ou mais provável, já as conhece.

Em 1988, o fundador da SoftQuad Yuri Rubinsky deu a Peter Sharpe, seu amigo de escola, a tarefa de desenvolver o Author/Editor para SGML, o primeiro aplicativo especializado para a edição de arquivos SGML.

Em 1989, Bob Horn publicou Mapping Hypertext, um livro extraordinário com ilustrações fantásticas - todas desenhadas pelo próprio Horn - exibindo o tipo de escrita estruturada que a Information Mapping esta propondo para todas as documentações. Este ainda é um dos livros mais importantes na história da documentação em geral (não é sobre documentos referentes a computadores). O livro descreve os sete tipos de informação de um documento estruturado - classificação, conceito, princípio, procedimento, processo, estrutura e fato. Horn se inspirou no famoso trabalho do professor de Harvard George Miller sobre o Magical Number Seven (mais ou menos dois) como o número de coisas que podem ser aprendidas facilmente de uma só vez.

A teórica do aprendizado Dr. Ruth Clark mais tarde resumiria estes tipos a cinco - conceito, principio, procedimento, processo e fato - seus tipos de informação para Treinamento e eLearnig - em seus workshops e no livro Developing Technical Training: A Structured Approach for Developing Classroom and Computer-based Instructional Materials. Mas Clark diz que sua idéia para os cinco tipos veio do teorista instrucional M.David Merrill e sua "Matriz de Performance-Conteúdo", e não da Information Mapping.

 

Anos 1990 - IBM Minimalism, Windows Help, and XML

 

In 1990 MIT Press published the research results of another IBM team led by John M. Carroll. Carroll's book, The Nurnberg Funnel introduced the idea of minimalism in technical writing. It was task orientation carried to an extreme. Minimalism meant small non-linear chunks readable in any order. It emphasized reading To Do, not reading To Know or To Learn, a phrase first introduced by Ginny Reddish. It attacked the standard systems approach to learning of Gagne and Briggs, with its hierarchical decomposition of learning objectives, which remains to this day as a standard in learning systems. And it emphasized handling errors when the user could not accomplish a task.

Minimalism included the earlier IBM task-based approach, and it limited instructions to the bare minimum needed to perform a single task, assuming that the user can find general information elsewhere, or very likely already knows it.

William Horton published Designing and Writing Online Documentation: Help Files to Hypertext in 1990. It contains clear references to many of the most important concepts in technical writing - task orientation and topic-based content, single sourcing and reuse, and conditional processing, Horton called for new names for tech writers - "document weavers" and "topic writers." Horton's topics had topic sentences, smooth transitions, and summaries. These are difficult to accomplish when online topics are written to be read in any order, and there is no beginning, middle, and end (p.216).

Also in 1990 Microsoft introduced WinHelp 1.0, developed by Ralph Walden, Cheryl Zubak, and others.

In 1991 Ed Weiss produced a book - How To Write Usable User Documentation - on structured and modular documentation that was itself an excellent example of structured and modular documentation, following closely the STOP methodology developed in the 1960's.

In 1991 Sun Microsystems introduced FrameBuilder, a version of FrameMaker with added support for SGML.

In 1991 Arbortext released Adept, their SGML editor, later to be known as Epic, and finally simply the Arbortext editor, when Arbortext was acquired by PTC.

In 1992 Blue Sky software released RoboHelp, a task-oriented, topic-based, online Help Authoring Tool (HAT). Later they changed the company name to eHelp. eHelp was acquired by Macromedia, prinmarily to get the Flash-based tool RoboDemo (now Captivate). RoboHelp was discontinued, but after Macromedia was acquired by Adobe, RoboiHelp became a strong part of Adobe's Technical Communication Suite, including FrameMaker.

In 1992 at Lotus a team of user assistance specialists started to design a single "Working Together" common help design for Lotus' office package SmartSuite and Lotus Notes. John Hunt (1-2-3), Janet Smith (Freelance Graphics), Bryan Steh (Word Pro), and Susanna Doyle (Notes) created a core design with six topic types: overview, context-sensitive, steps, details, examples, glossary, and reference. It used Notes for content management and WordPro templates for editing, with single-source/multiple output to a variety of delivery formats.

In 1992 the HyTime standard for Hypermedia and Time-based content (an application of the SGML architecture) identified problems with linking document types that was to inform the specialization mechanism in DITA.

In 1994 JoAnn Hackos published her landmark Managing Your Documentation Projects, revised and republished as Information Development: Managing Your Documentation Projects, Portfolio, and People by Wiley in 2006. Fully in tune with task orientation, Hackos book described only three information types - concept, procedure, and reference (p.236). This seems to be a combination of Information Mapping's seven types, Ruth Clark's simplification to five types, and Apple Macintosh Documentation Guidelines three components.

In the mid '90's, Yuri Rubinsky's team at SoftQuad (creators of one of the first and most popular HTML editors, HoTMetaL, became involved in the development of a compromise markup language somewhere between the extraordinarily complex SGML and the popular new HTML (Hypertext Markup Language) for web pages. (HoTMetaL was the precursor to today's XMetaL from Justsystems.) HTML was a disaster from the point of structured reusable component documentation, not least because it combined presentation markup with structural markup. The new markup language was XML (eXtensible Markup Language), and SoftQuad developed one of the first XML editors, XMetaL.

In November 1995 John Carroll convened a workshop, sponsored by the Society of Technical Communication (STC), to evaluate Minimalism in the years since the Nurnberg Funnel. Carroll invited his major colleagues - R. John Brockmann, David Farkas, JoAnn Hackos, Hans van der Meij, Janice C. (Ginny) Reddish, and others.

In 1995 Adobe acquired FrameMaker and FrameBuilder, which was to become FrameMaker + SGML, and eventually the more affordable Structured FrameMaker, now included with every copy of FrameMaker, though used by a small percentage of tech writers. Most writers continue to prefer unstructured documents.

In 1995 CNET Founders Halsey Minor and Jonathan Rosenberg built their own Web content management system and it introduced a number of today's core capabilities, like content reuse and personalization. Page templates assembled the content dynamically from a relational database. They sold the system to Vignette for a share in that new company. It was the first "content management system (CMS)."

In Toronto in 1996, an IBM documentation team including Michael Priestley, Bob Fraser, Dennis Bockus, and Jamie Roberts was developing a Help system for IBM's new line of VisualAge software. Roberts had just returned from graduate study at University of Waterloo and attended a brainstorming session to define some basic information topic types for the new Help. He was inspired by Lotus' online help in 1-2-3, which then had the reputation of being very good at user experience. Lotus Help included procedures (called "steps") and overview (concept). Roberts scribbled "concept, task, and reference" on a napkin, handed it to Bockus for implementation, and a new help document architecture was born. There is not much unusual about a Help system that is task-based and assembled from topics. What was new was that this was to become the simplified form of XML known as DITA, with very significant contributions from Lotus, which IBM had just acquired. And it was to be both web-based and delivered as a PDF.

After the release of Windows 95 and WinHelp 4, in 1996 Scott Boggan, David Farkas, and Joe Welinske wrote Developing Online Help for Windows 95. It had a strong task orientation and was topic-based. But "concept/overview" was only one of ten standard topics, which did not include "reference," but did wisely include errors and troubleshooting.

In 1996, IBM signed a long-term agreement to use the Arbortext Adept editor for internal SGML document creation.

In 1997 Microsoft released Compressed HTML Help (.CHM), based on compiled HTML, images, and Javascript.

In 1998, JoAnn Hackos and Ginny Reddish published the definitive reference on task analysis, User and Task Analysis for Interface Design, and John Carroll published the edited proceedings of his 1995 workshop, Minimalism Beyond the Nurnberg Funnel, with major contributions by Hackos and Reddish.

In 1998, IBM revised their 1980's PQTI tech writing guide, retitling it Developing Quality Technical Information. The team of writers was led by Gretchen Hargis and included only one from the PQTI team, Polly Hughes. They now cited nine quality characteristics - accuracy, clarity, completeness, concreteness, organization, retrievability, style, task orientation, and visual effectiveness. Note that task orientation had slipped from first to eight out of nine quality characteristics.

The 2000's - IBM DITA

 

In March 2001, IBM introduced DITA as a series of developerWorks articles about a new simplified version of XML for documentation. It was intended to replace IBM's IBM ID Doc, an internal version of SGML for IBM's technical software support. While XML was enjoying great use as a data exchange method (RSS and SOAP protocols), it had little traction as a document markup language. DITA was an attempt to make a simplified XML starter set for documentation markup, one designed from the outset to encourage reuse of small content components. The key ideas were to be simpler than the complex SGML and also be usable online.

The goal of DITA was to formalize information typing practices, both print and online, and also enable an extensible typing architecture through specialization of base topics. DITA maps were a way to standardize collection publishing and information architecture/outlining models. DITA was initially known as MITA, for Mendel Information Typing Architecture, to emphasize the object orientation of the new architecture, with its "inheritance" and evolution of topic structures via specialization. Since MITA was already a somewhat proprietary acronym, IBM switched to Darwin and DITA.

In May 2002, IBM added domain specialization to topic specialization, and demonstrated these in the Open Toolkit, a reference implementation of DITA publishing, with a starter set of XSLT stylesheets. IBM encouraged authoring tool vendors to integrate the Open Toolkit as a means of publishing DITA, and most have done so.

JoAnn Hackos' Content Management for Dynamic Web Delivery was published in 2002. She described creating an information (content) model and developing information types, such as procedures, concepts, warnings, specifications, and others. Michael Priestley, the DITA specialization architect, and Dave Schell, then the principal DITA evangelist for IBM, wrote a 3-page vignette on DITA, perhaps its first mention in a book. They stressed topic orientation, information typing, specialization, inheritance, and two architectures, one for information and one for specialization. Hackos briefly mentions the AutoCAD Learning Assistance software she and learning guru Wayne Hodgins developed for Autodesk. It was cleverly dubbed CPR for its three-tabbed interface to concept, procedure, and reference.

In 2003, two books appeared on single sourcing and content reuse, Single sourcing: Building Modular Documentation, by Kurt Ament, and Managing Enterprise Content, by Ann Rockley.

In 2003, IBM published a second edition of Developing Quality Technical Information, by Gretchen Hargis and others. Now the nine quality characteristics were rearranged once more, putting task orientation first again. More importantly, they added an introductory chapter that called for content to be structured as separate information types, specifically task, concept, and reference. (Note the correct order of the three basic DITA information types.) This book is all about DITA without mentioning the name, probably because IBM was using DITA internally but not yet sharing it with the world when the book was drafted.

OASIS DITA

 

In April 2004, the Organization for the Advancement of Structured Information Standards (OASIS), formed a Technical Committee to explore a DITA Standard. The TC included XML tools vendors, consultants on Information Architecture and Content Management Systems (CMS), and end users of the DITA Document Type Definitions (DTD) and Schemas needed for the new DITA Standard.

In February 2005, IBM donated the Open Toolkit, a limited version of their internal Information Developers Workbench, to SourceForge. IBM continues to develop the OT, which is not a part of the OASIS DITA Standard efforts.

DITA 1.0

DITA 1.0 was approved as an OASIS Standard in June 2005

DITA 1.1

DITA 1.1 was approved in August 2007, adding a new Bookmap specialization.

DITA 1.2

DITA 1.2 is expected sometime in 2008. It will add structured learning, creation of Learning Objects with DITA, which will be compatible with eLearning standards such as SCORM.

References

From Millwrights to Shipwrights to the Twenty-First Century: Explorations in a History of Technical Communication in the United States, by R. John Brockmann.

History of Outlining (and STOP).

Quick Reader Comprehension (1961).

Hughes STOP - Sequential Thematic Organization of Publications (1965).

IBM Improving usability of publications (1981). Task-orientation HTML version

Writing Better Computer User Documentation (1986)

Mapping Hypertext, Robert Horn, Lexington Institute (1989).

Developing Technical Training: A Structured Approach for Developing Classroom and Computer-based Instructional Materials, Dr. Ruth Clark (1989, 2nd edition, 1999).

Designing and Writing Online Documentation: Help Files to Hypertext, by William Horton (1990).

The Nurnberg Funnel, John M. Carroll, MIT Press(1990).

How To Write Usable User Documentation, by Edmond Weiss, Oryx, (1991)

Managing Your Documentation Projects, by JoAnn Hackos (Wiley, 1994).

Developing Online Help for Windows 95, by Scott Boggan, David Farkas, and Joe Welinske, (Solutions, 1996).

Standards for Online Communication, by JoAnn Hackos (Wiley, 1997).

Robert Horn, Visual Language (1998).

User and Task Analysis for Interface Design, by JoAnn Hackos and Janice C. (Ginny) Reddish (1998).

Minimalism Beyond the Nurnberg Funnel, John Carroll, MIT Press(1998).

Two approaches to modularity (1999). Robert Horn compares structured writing to Hughes STOP.

Review of the Nurnberg Funnel (1999) Robert Horn compares structured writing to Minimalism.

The Impact of Single Sourcing and Technology, Ann Rockley, 2001.

Cisco/Clark Reusable Learning Objects.

Content Management for Dynamic Web Delivery, by JoAnn Hackos (Wiley 2002).

Managing Enterprise Content, by Ann Rockley, New Riders, 2003.

Single sourcing: Building Modular Documentation, by Kurt Ament, Andrew Publishing, 2003.

Robert Horn Powerpoint on Visual Language.(2003).

Developing Quality Technical Information: A Handbook for Writers and Editors (2nd Edition) , by Gretchen Hargis, Michelle Carey, Ann Kilty Hernandez, Polly Hughes, Deirdre Longo, Shannon Rouiller, Elizabeth Wilde (IBM Press, Information Management Series, 2004).

Information Development: Managing Your Documentation Projects, Portfolio, and People, by JoAnn Hackos (Wiley, 2006).

 

See Portuguese translation of this page.

XML.org Focus Areas: BPEL | DITA | ebXML | IDtrust | OpenDocument | SAML | UBL | UDDI
OASIS sites: OASIS | Cover Pages | XML.org | AMQP | CGM Open | eGov | Emergency | IDtrust | LegalXML | Open CSA | OSLC | WS-I