Documento de Projeto (português)

Nº
TIPO DE DOCUMENTO
Título
Página
TÍTULO DO DOCUMENTO
Proyecto
Nome ou Logo
Cliente
TT-CCCC-UUUUU-A4-AAA-sss
1 de t
NOME DO PROJETO
Área
ÁREA (si existir)
CONTROLE DE REVISIONES
Propósito de la Emisión
Rev.
0
PROPÓSITO (EX. PARA APROBACIÓN, PARA CONSTRUCCIÓN, ETC.)
Rev. 0
Fecha
dd/mm/aa
Realizó
SIGLA
Revisó
SIGLA
Aprobó
SIGLA
A4-GNEe R0 210x297 mm
Rev. A
Rev. B
Rev. C
Rev. D
Rev. E
Nº
TIPO DE DOCUMENTO
Título
Rev.
TT-CCCC-UUUUU-A4-AAA-sss
TÍTULO DO DOCUMENTO
Proyecto
R
Página
2 de 8
NOME DO PROJETO
SUMÁRIO
Folha
1
INTRODUÇÃO
3
2
FONTE
3
3
ESTRUTURA
3
3.1
3.2
3.3
Subdivisão do Conteúdo
Enumerações
Notas e Exemplos Integrados ao Texto
3
4
6
4
NUMERAÇÃO E TÍTULO DAS SEÇÕES E SUBSEÇÕES (OU “ITENS”)
7
4.1
Criando uma Nova Seção ou Subseção
7
5
CRIANDO UM TÍTULO DE ANEXO
7
6
SUMÁRIO
7
Anexo A – Título do Anexo
8
A4-GNEe R0 210x297 mm
Nº
TIPO DE DOCUMENTO
Título
TÍTULO DO DOCUMENTO
Proyecto
1
Rev.
TT-CCCC-UUUUU-A4-AAA-sss
Página
3 de 8
NOME DO PROJETO
INTRODUÇÃO
Este é o padrão de documento de Projeto da GENPRO elaborado no formato A4 com o
programa Microsoft Word.
Ele contém previamente preparados vários recursos automáticos de margens, fontes,
estilos, numeração, etc. que, quando utilizados, uniformiza, facilita e agiliza a elaboração
destes documentos.
2
FONTE
A fonte definida e carregada por default neste modelo é Arial tamanho 11, espaçamento
normal.
3
ESTRUTURA
3.1
Subdivisão do Conteúdo
Os termos que devem ser utilizados para designar as divisões e subdivisões são
mostrados na Tabela 1.
Tabela 1 – Termos das Divisões e Subdivisões
Exemplo de Numeração
Termo
SEÇÃO
1
Subseção Primária
1.1
Subseção Secundária
1.1.1
Parágrafo
[sem número]
Anexo
A
Os títulos das seções são grafados em letras maiúsculas e em negrito. Os títulos das
subseções primárias serão grafados também em negrito, porém somente a primeira letra
de cada palavra deve ser maiúscula (exceto em preposições, conjunções, artigos e
advérbios, independentemente do número de sílabas, todas as letras devem ser grafadas
em minúsculas). As subseções secundárias seguem as mesmas regras das subseções
primárias, exceto que não são grafadas em negrito.
Os títulos de anexos seguirão o padrão dos títulos das subseções secundárias (em
negrito e as primeiras letras de cada palavra em maiúsculas), numerados em ordem
alfabética (ver exemplo neste modelo).
Os parágrafos serão justificados (alinhados à esquerda e à direita). Entre cada parágrafo
de texto, títulos de seções, subseções e enumerações adota-se um parágrafo (uma “linha
em branco”) de espaçamento, exceto ao se iniciar uma seção, onde se devem adotar
dois espaçamentos antes do título da seção (veja exemplos acima ao fim das seções 1 e
2).
A4-GNEe R0 210x297 mm
R
Nº
TIPO DE DOCUMENTO
Título
Proyecto
Rev.
TT-CCCC-UUUUU-A4-AAA-sss
TÍTULO DO DOCUMENTO
Página
4 de 8
NOME DO PROJETO
Para texto, o respectivo estilo “Texto” está disponível. Os textos são justificados
(alinhados à esquerda e à direita). O parágrafo para texto apresenta um recuo de 1,5 cm
à esquerda e à direita está alinhado com a margem. A margem esquerda do documento é
de 2,5 cm (onde se inicia a numeração) e a margem direita é de 1,5 cm.
Sendo a largura da folha igual a 21,0 cm, o comprimento do texto resultante é de:
Comprimento do Texto = largura da folha – margem esquerda – recuo – margem direita =
= 21,0 – 2,5 – 1,5 – 1,5 = 15,5 cm
– Enumerações
As enumerações (listas metódicas) dentro do texto podem ser apresentadas por meio de
uma sentença (ver Exemplo 1), de uma proposição gramatical completa seguida de dois
pontos (ver Exemplo 2), ou pela primeira parte de uma proposição sem dois pontos (ver
Exemplo 3), completada pelos itens da enumeração.
Cada item da enumeração deve ser precedido de um travessão (–) ou, caso necessário
para identificá-lo, de uma letra minúscula seguida de parêntese (alínea alfabética). Se
houver necessidade de subdividir mais um item deste último tipo de enumeração,
devem-se utilizar algarismos arábicos seguidos de parênteses (ver Exemplo 1).
Os itens enumerados são alinhados com a margem esquerda do texto normal (1,5 cm de
recuo esquerdo), sendo marcados por um travessão e o texto deslocado 0,5 cm do
travessão (recuo de 2,0 cm).
Os itens das subenumerações são alinhados com a margem esquerda das enumerações
(2,0 cm de recuo esquerdo), sendo utilizado um marcador com o texto deslocado 0,5 cm
do marcador (recuo de 2,5 cm). Para detalhes, ver Exemplo 4, onde se utilizou como
marcador o ponto centralizado (•)
Cada item da enumeração e da subenumeração inicia-se com letra minúscula, exceto
quando a ortografia assim o exigir. Atente ao fato de que o corretor ortográfico do
Microsoft Word erroneamente insiste que esta letra seja maiúscula.
Para enumerações deve ser utilizado o estilo ”– Lista” disponível. Para subenumerações,
utilize “• Sublista”.
Para enumerações identificadas (alínea alfabética) deve ser utilizado o estilo “a) Lista
alfabética” e para subenumerações deve ser utilizado o estilo “1) Sublista numérica”.
EXEMPLO 1
Os princípios básicos a seguir devem ser aplicados na redação de definições.
a) a definição deve ter a mesma forma gramatical do termo:
1) para definir um verbo, deve ser usada uma frase verbal;
2) para definir um nome no singular, deve ser usado o singular.
b) a estrutura preferencial para uma definição é uma parte fundamental que indica a
classe à qual o conceito pertence.
A4-GNEe R0 210x297 mm
R
Nº
TIPO DE DOCUMENTO
Título
Proyecto
Rev.
TT-CCCC-UUUUU-A4-AAA-sss
TÍTULO DO DOCUMENTO
Página
5 de 8
NOME DO PROJETO
c) a definição de uma grandeza deve ser formulada de maneira que uma grandeza
derivada pode ser definida por meio de outras grandezas. Nenhuma unidade deve ser
usada na definição da grandeza.
EXEMPLO 2
Neste modelo de documento, estão definidos os seguintes espaçamentos automáticos
entre parágrafos:
– espaçamento simples entre linhas e sem espaçamento antes e depois, para o Título
de Seções (estilo “1 Título 1, SEÇÃO”);
– idem para o Título de Subseções Primárias (estilo “1.1 Título 2, Subseção Primária”);
– idem para o Título de Subseções Secundárias (estilo “1.1.1 Título 3, Subseção
Secundária”);
– idem para enumerações e subenumerações (estilos “– Lista”, “• Sublista”, “a) Lista
alfabética” e “1) Sublista numérica”).
EXEMPLO 3
Nos Títulos de Subseções Primárias, as palavras não receberão a primeira letra
maiúscula, independentemente do número de sílabas, quando pertencerem à classe
gramatical das
– preposições,
– conjunções,
– artigos, e
– advérbios.
EXEMPLO 4
No título de uma seção, observe os seguintes detalhes de apresentação:
– grafia com letras maiúsculas e em negrito;
– não se utiliza grifo;
– espaçamento
• simples entre linhas,
• sem espaçamento antes, e
• sem espaçamento depois;
– a primeira letra do título está alinhada com a margem esquerda do texto.
A4-GNEe R0 210x297 mm
R
Nº
TIPO DE DOCUMENTO
Título
TÍTULO DO DOCUMENTO
Proyecto
3.1.1
Rev.
TT-CCCC-UUUUU-A4-AAA-sss
Página
6 de 8
NOME DO PROJETO
Pontuação das Enumerações
Observe atentamente os exemplos mostrados anteriormente. No Exemplo 1, como a
enumeração foi apresentada através de uma frase completa (com ponto final), as
enumerações a, b, e c seguem este padrão (ponto final) ao término.
No Exemplo 2, como se utilizou uma proposição inicial seguido de dois pontos, as
enumerações terminam com ponto e vírgula.
Já no Exemplo 3, como a proposição inicial está com a frase incompleta, tudo se passa
como se as enumerações formassem uma única frase, com vírgula após cada
enumeração. Na penúltima enumeração é colocado um “e” ao final.
Finalmente, no Exemplo 4 é mostrada uma combinação de ambas as pontuações (ponto
e vírgula e vírgula).
3.2
Notas e Exemplos Integrados ao Texto
Quando a nota for única, deve ser realizada conforme indicado abaixo.
NOTA
Aqui vai descrito todo o texto da nota, que poderá ocupar quantas linhas
forem necessárias. Observe que se utiliza igualmente o estilo “Texto” e se inicia o texto
da nota com letras maiúscula, recuado à esquerda (aqui foi utilizada uma tabulação a 3,5
cm da margem). O texto da nota é encerrado com ponto final.
Quando houver mais de uma nota, estas devem ser numeradas a partir de 1, e indicadas
como mostrado abaixo.
NOTA 1
As notas (e exemplos) integradas ao texto só devem ser utilizadas para dar
informações adicionais que facilitem a compreensão, não devendo conter requisitos ou
qualquer outra informação considerada indispensável.
NOTA 2
Recomenda-se que as notas (e exemplos) sejam colocadas ao final da seção
ou subseção, ou após os parágrafos aos quais estas se referem.
NOTA 3
Aqui vai o texto da terceira nota.
A indicação de um ou mais exemplos segue o mesmo padrão definido para as notas,
como mostrado a seguir.
EXEMPLO
Aqui vai indicado o texto do exemplo. Perceba que aqui foi utilizada uma
tabulação de 4,5 cm da margem, 1 cm maior que a da nota, pois o a palavra “exemplo” é
mais longa.
Para mais de um exemplo:
EXEMPLO 1
Aqui vai indicado o texto do primeiro exemplo que pode ocupar tantas
linhas quanto forem necessárias.
EXEMPLO 2
Aqui vai indicado o texto do segundo exemplo.
EXEMPLO 3
Aqui vai indicado o texto do terceiro exemplo.
A4-GNEe R0 210x297 mm
R
Nº
TIPO DE DOCUMENTO
Título
TÍTULO DO DOCUMENTO
Proyecto
4
Rev.
TT-CCCC-UUUUU-A4-AAA-sss
Página
7 de 8
NOME DO PROJETO
NUMERAÇÃO E TÍTULO DAS SEÇÕES E SUBSEÇÕES (OU “ITENS”)
As seções e subseções estão utilizando numeradores automáticos no título. Se um deles
for eliminado, imediatamente todos os outros serão automaticamente renumerados.
4.1
Criando uma Nova Seção ou Subseção
Para criar uma nova seção ou subseção, posicione o cursor onde se pretende inseri-la,
selecione na caixa de estilos localizada na barra de ferramentas: “1 Título 1, SEÇÃO”,
ou “1.1 Título 2, Subseção Primária”, ou “1.1.1 Título 3, Subseção Secundária”. Será
criada a seção ou subseção e todas as outras serão renumeradas. Digite a seguir o título.
Outra opção é copiar o título de uma seção (ou subseção, se este for o caso) e colar no
ponto onde se pretende inserir. Automaticamente a seção ou subseção será colada com
o número na sequência correta do documento e todos os outros números de seção ou
subseção serão corrigidos. A seguir, basta editar o texto do título.
NOTA
Parágrafos não serão numerados e o estilo definido é designado de “Texto”.
Toda numeração de seção ou subseção tem que ter um título. Não utilize mais que dois
subníveis de subseção. Use sua imaginação!
4.1.1
Exemplo de uma Subseção Secundária
Este trecho é um exemplo de uma subseção secundária. Observe acima como o título é
grafado. Não crie mais subníveis como, por exemplo, 3.1.1.1. Perceba, ainda, que o
Sumário automático não inclui esta subseção.
5
CRIANDO UM TÍTULO DE ANEXO
Para criar um título de anexo, proceda como no caso da seção, selecionando este estilo
ou colando um já existente e posteriormente fazendo a edição.
6
SUMÁRIO
O Sumário que aparece no início é um índice automático. Não se deve editar nada
diretamente sobre ele! Em qualquer etapa de elaboração do documento o sumário pode
ser atualizado para reportar a situação corrente do documento. Com o cursor posicionado
em qualquer ponto do Sumário, clique com o botão direito do mouse, selecione Atualizar
Campo, em seguida selecione Atualizar o índice inteiro. Outro recurso do Sumário é o link
para o assunto dentro do documento. Ao se clicar no número da folha que é mostrado na
frente do item descrito no Sumário, automaticamente a imagem na tela será conduzida
para este item dentro do documento, com o cursor se posicionando no título deste item.
Não se esqueça de fazer a última atualização do Sumário ao encerrar o documento.
O sumário deve ser utilizado em documentos extensos, com mais de 10 folhas. Para
documentos com poucas folhas, apague o modelo pré-existente. No sumário não
constarão as subseções secundárias.
______________________
A4-GNEe R0 210x297 mm
R
Nº
TIPO DE DOCUMENTO
Título
Proyecto
Rev.
TT-CCCC-UUUUU-A4-AAA-sss
TÍTULO DO DOCUMENTO
NOME DO PROJETO
Anexo A – Título do Anexo
A4-GNEe R0 210x297 mm
Página
8 de 8
R