A arte de bem documentar é difícil e pouco atractiva. Felizmente muita documentação necessária usualmente não requer grande elaboração. Nestes casos torna-se útil agilizar o processo.
Agilizar como? Texto! O “formato texto” é simples, prático e funcional. Todos os sistemas de comunicação populares baseiam-se em interfaces cujo input é feito em texto simples ou em sistemas muito simplificados de formatação. Mail, blogs, foruns online, twitter, são alguns exemplos.
As grandes lacunas do texto simples são a falta de capacidade de estruturação e inclusão de elementos gráficos. No entanto, usando-se algumas convenções e software que as processe, consegue-se adicionar elementos que conferem alguma estrutura ao texto. Estes sistemas permitem estruturar um texto banal apenas com ligeiras anotações não intrusivas e convertê-lo em vários formatos possíveis, como html, docbook, odf openoffice, latex, rtf e pdf. Um outro formato de saída interessante e geralmente suportado é o s5 que permite construir apresentações em html.
Alguns sistemas populares:
Software de processamento:
O output poderá ser o documento final ou um trecho para incluir noutro sistema de documentação.
Com este tipo de abordagem consegue-se escrever documentação de forma rápida e flexível, ou seja, ágil.
Sem comentários:
Enviar um comentário