Manual de Documentación - Javier Lasso de La Vega

Introdução

Você já se perguntou como os documentos são criados e gerenciados? Se sim, então este livro é para você! O Manual de Documentação, de Javier Lasso de la Vega, é um guia abrangente sobre o processo de documentação, desde o planejamento até a publicação.

O que é documentação?

Documentação é o processo de criar, gerenciar e distribuir informações. Ela pode ser usada para uma variedade de propósitos, incluindo:

Fornecer instruções sobre como usar um produto ou serviço
Registrar informações sobre um processo ou evento
Preservar o conhecimento institucional
Comunicar informações a um público específico

O processo de documentação

O processo de documentação pode ser dividido em várias etapas, incluindo:

Planejamento: Nesta etapa, você define o objetivo da documentação, identifica o público-alvo e determina o tipo de documentação que será criada.
Coleta de informações: Nesta etapa, você reúne todas as informações necessárias para criar a documentação. Isso pode incluir entrevistas com especialistas, pesquisas e análise de documentos existentes.
Organização das informações: Nesta etapa, você organiza as informações de forma lógica e coerente. Isso pode envolver a criação de um índice, sumário e capítulos.
Escrita: Nesta etapa, você escreve a documentação. Isso pode envolver a criação de texto, gráficos e tabelas.
Revisão: Nesta etapa, você revisa a documentação para garantir que ela esteja correta, completa e bem escrita.
Publicação: Nesta etapa, você publica a documentação. Isso pode envolver a impressão de cópias físicas ou a publicação online.

Tipos de documentação

Existem muitos tipos diferentes de documentação, incluindo:

Documentação técnica: Este tipo de documentação fornece instruções sobre como usar um produto ou serviço.
Documentação de processo: Este tipo de documentação registra informações sobre um processo ou evento.
Documentação institucional: Este tipo de documentação preserva o conhecimento institucional.
Documentação de comunicação: Este tipo de documentação comunica informações a um público específico.

Ferramentas de documentação

Existem muitas ferramentas diferentes disponíveis para ajudar no processo de documentação, incluindo:

Processadores de texto: Esses programas permitem que você crie e edite documentos de texto.
Programas de diagramação: Esses programas permitem que você crie diagramas e fluxogramas.
Programas de gerenciamento de documentos: Esses programas permitem que você gerencie e armazene documentos.
Sistemas de publicação eletrônica: Esses sistemas permitem que você publique documentos online.

Conclusão

O Manual de Documentação é um recurso valioso para qualquer pessoa que esteja envolvida no processo de documentação. Ele fornece informações abrangentes sobre todas as etapas do processo, desde o planejamento até a publicação. Se você está procurando melhorar suas habilidades de documentação, então este livro é para você!

Sobre o autor

Javier Lasso de la Vega é um especialista em documentação com mais de 20 anos de experiência. Ele é autor de vários livros sobre documentação, incluindo o Manual de Documentação. Lasso de la Vega também é professor de documentação na Universidade de Madri.