Formato para Preparação de Documentos, Trabalhos Escolares e Relatórios em Geral

Jorge Henrique Cabral Fernandes (jorge@dimap.ufrn.br)

Universidade Federal do Rio Grande do Norte - DIMAp

Fevereiro de 2002

Objetivos

Este documento define padrões de estrutura de documentos, que podem ser usados para organizar trabalhos escolares, relatórios científicos e de engenharia.

Esboço de Estrutura Simplificada para Documento

O documento usado como exemplo de estrutura simplificada está dividido duas partes: Capa e Corpo.

Informações adicionais, que indicam qual a intenção e como organizar cada parte do documento são mostradas abaixo no esboço de estrutura detalhada.

Esboço de Estrutura Detalhada para Documento

O documento de maior porte está dividido em três partes cabeça, corpo e apêndices. A cabeça contém, além da capa, outros elementos como contracapa e resumo. O corpo apresenta uma estrutura mais definida e detalhada, que varia muito conforme a natureza do documento. Os apêndices contém informações acessórias, como anexos e índices.
Cabeça
Contém várias unidades de informação introdutória
Capa
Perceba que a capa é dividida em três partes: cabeçalho, corpo e rodapé.
  • O cabeçalho contém informações gerais sobre a instituição, departamento, curso, disciplina, etc., à qual o documento é vinculado.
  • O corpo da capa contém o que interessa realmente: o título do trabalho e os autores. O título pode ter subtítulos e número de versão. Se for uma descrição de produto ou projeto, uma figura ou logo pode estar associada. Os autores devem estar destacados, com primeiro e último nomes (nome da família). Adicionalmente é importante informar o endereço de e-mail.
  • O rodapé da capa indica o local e data onde foi escrito o documento.
    Contracapa
    Contém informações de copyrigth, se necessário.
    Histórico de Alterações
    Contém uma tabela que registra as várias alterações pelas quais o documento passou durante seu ciclo de vida, como a tabela abaixo.
    Data Versão Conteúdo Responsáveis
    23/01/2003 Alfa Inicial Fulano
    20/02/2003 Beta 1 Acrescentada seção XYZ. Correções na descrição ABC Beltrano
    Resumo
    Contém um resumo do documento, destacado em uma página isolada. Usado normalmente quando o documento é um artigo, dissertação ou tese. Normalmente acompanha uma versão em inglês do resumo, chamada de Abstract.
    Tabela de Conteúdos
    Contém a estruturação hierárquica do corpo do documento, destacada em uma página isolada. Usada em documentos grandes.
    Tabela de Figuras
    Contém a relação das figuras que estão constantes no documento e a página onde elas se encontram, destacada em uma página isolada. Usada em documentos grandes.
  • Corpo do documento
    Sugere-se que o corpo de um documento com até 10-15 páginas seja dividido em seções, subseções e parágrafos. Se o documento for maior (+ 50 páginas) então é dividido em capítulos, seções, subseções e parágrafos. Se for muito grande (normalmente + de 10 capítulos) os capítulos podem ser agrupados em partes (Parte I, Parte II, etc.). Os capítulos, seções, subseções, etc., devem ser numerados, o que auxilia na navegação.

    As seções típicas do corpo um documento são

    Prefácio
    Se existir um prefácio no documento este deve ser numerado como Seção 0. Perceba que o nome próprio de uma seção (ex: "Seção 0") começa com letra maiúscula. O prefácio contém informações breves sobre o escopo do documento, a qual público se destina, o que o leitor deve conhecer antes de ler o documento. Adicionalmente o prefácio contém uma descrição do que está por vir, chamada de mapa ou "roadmap". O mapa indica como o resto do documento está organizado em seções e o que cada seção contém. Perceba que o prefácio contém uma versão compacta do Resumo e da Tabela de Conteúdos.
    Introdução
    Introduz o tema de discussão do documento, e fornece uma visão geral detalhada de todos os aspectos que serão tratados no documento. O texto de introdução normalmente contém intersecção com o que foi mencionado no resumo.
    Seções do Núcleo
    Dependento do tipo de documento vários seções ou capítulos se seguem, as quais contém a contribuição mais importante do documento, o que se produziu, como se produziu, os resultados obtidos, análises do que foi produzido.

    Por exemplo, se o documento contém uma descrição de software as seguintes seções poderão estar presentes:

  • Requisitos Funcionais
  • Requisitos não funcionais
  • Visão arquitetural do software
  • Design detalhado
  • Implementação
  • Testes, etc.

    Se o documento é um artigo científico as seguintes seções poderão estar presentes:

  • Metodologia
  • Montagem do Experimento
  • Resultados
  • Discussão
    Conclusões
    Em praticamente todos os documentos existe uma seção que fornece conclusões gerais sobre o que foi apresentado. Trata-se de um resumo do documento, mas que já considerou que o leitor já conhece o trabalho com mais detalhes.
    Bibliografia
    Relação dos materiais bibliográficos usados na confecção do documento.
  • Apêndice
    tudo que não couber na cabeça e no corpo vai para as seções de Apêndices
    Anexos
    Várias seções com dados e outras informações que não puderam ser inseridos nas seções do Núcleo, seja devido ao tamanho, seja para não quebrar o ritmo de leitura com excesso de dados, seja para facilitar a compreensão de maiores detalhes pelos leitores mais interessados. Coloque no anexo tudo o que puder ser retirado do Núcleo sem prejudicar a compreensão do texto.
    Índice
    Uma relação das palavras mais importantes usadas no documento, com índicação das páginas nas quais foram usadas. Facilita a navegação em documentos com muitas informações técnicas.

    Jorge Henrique Cabral Fernandes, DSc
    Professor Adjunto I - DIMAp - UFRN
    Last updated 26.02.2002