-
Notifications
You must be signed in to change notification settings - Fork 23
Home
Este pequeno guia visa apoiar a redação de textos técnicos relacionados ou pertinentes ao Guia de uso de elementos e atributos XML para documentos que seguem a implementação SciELO Publishing Schema, e foi baseado em alguns documentos, a saber:
- Vocabulário Ortográfico da Língua Portuguesa da Academia Brasileira de Letras;
- Manual de redação, estilo e comunicação do Departamento Nacional do SESC (aqui denominado Manual do SESC); e
- Manual de Redação e Estilo do Estadão.
A linguagem deve ser formal, sem exagero, simples, concisa e direta, evitando-se palavras pouco utilizadas (erudição), em desuso ou conotativas.
O texto deve ser escrito na terceira pessoa do plural (dissertação objetiva), pois é impessoal, mais fácil de ser seguido com fidelidade e dá um aspecto de "autoridade" ao tema discursado. Nisso difere do Manual do SESC que adotou a escrita na primeira pessoa do plural para conferir uma identidade institucional única às múltiplas equipes redatoras da organização.
Prefere-se a redação de parágrafos curtos, porém sempre contendo informação suficiente ao entendimento do contexto e de sua aplicação. Evitar intercalações excessivas ou ordens inversas desnecessárias.
Ex.
Tag que identifica o resumo do artigo e não deve conter informação de atributo@xml:lang. Embora em via de regra esse elemento ocorra zero ou mais vezes, ele se faz obrigatório quando elemento-article for declarado com o atributo@article-type="research-article"ou@article-type="review-article". Em<abstract>deve ser inserido um elemento title para especificar o título do resumo.
Embora seja um parágrafo relativamente curto, poderia ser simplificado:
Elemento que identifica o resumo de um artigo. Não deve conter o atributo
@xml:lang. Embora<abstract>possa não ocorrer, faz-se obrigatório quando<article-meta>for declarado com atributo@article-type="research-article"ou@article-type="review-article".
<abstract>contém obrigatoriamente um elemento <title> que especifica o título do resumo.
Note
foram também revisados os termos preferidos e as convenções e nomenclaturas (em vermelho). O termo <abstract> aparece repetidas vezes para facilitar o entendimento.
O texto deve ser capaz de responder a seis possíveis perguntas: quem, o que, quando, como, onde e por que. Este é o método Kipling (5W1H) para apoiar na solução de problemas e estimular a mente a descrever de forma simples e clara cada conceito necessário à comunicação de uma ideia.
Ex.
SciELO (Scientific Electronic Library Online) é um modelo para a publicação eletrônica cooperativa de periódicos científicos na Internet, desenvolvido cooperativamente entre FAPESP, BIREME e outras instituições desde 1997. Nascido para responder às necessidades da comunicação científica nos países em desenvolvimento - particularmente na América Latina e Caribe -, proporciona uma maior visibilidade e acesso a sua literatura científica, além de estatísticas bibliométricas e de uso.
Portanto:
- O que?
- SciELO (Scientific Electronic Library Online) é um modelo para a publicação eletrônica cooperativa de periódicos científicos na Internet,
- Como?
- desenvolvido cooperativamente
- Quem?
- entre FAPESP, BIREME e outras instituições
- Quando?
- desde 1997.
- Porque?
- Nascido para responder às necessidades da comunicação científica proporciona uma maior visibilidade e acesso a sua literatura científica, além de estatísticas bibliométricas e de uso.
- Onde?
- nos países em desenvolvimento - particularmente na América Latina e Caribe -,
Deve-se evitar começar períodos ou parágrafos seguidos com a mesma palavra ou expressão, como também evitar o uso repetido da mesma estrutura de frase.
Reler e reescrever faz parte do processo de criação de um texto claro, conciso e simplificado. Deste modo pode-se garantir que a informação é comunicada de forma eficiente.
Ex.
A especificação SciELO Publishing Schema — também chamada SciELO PS — é composta pela especificação NISO JATS Journal Publishing DTD na versão 1.0 mais o Estilo SciELO, que são regras que especializam aspectos da especificação JATS Publishing. Os usuários deste guia devem possuir conhecimentos prévios sobre XML e familiaridade com DTD.
Poderia ser reescrito como:
A SciELO Publishing Schema (SciELO PS) é composta pelas especificações:
- NISO JATS Journal Publishing DTD, versão 1.0;
- Estilo SciELO com regras especializadas da Metodologia SciELO.
Os usuários deste guia devem possuir conhecimentos prévios de XML e DTD.
Exceto quando explicitamente necessário, os endereços URL devem ser descritos na seção de referências sob o tema ou assunto ao qual se referem. Esta regra visa tornar o texto mais limpo, e por consequência, mais claro ao leitor. Oportunamente, pode ser criado link entre o termo e a referência para facilitar o acesso.
Ex.
Será utilizada a linguagem de marcação RST (reStructuredText) para formatar e habilitar recursos de hipertexto aos documentos. Uma referência dessa linguagem encontra-se disponível em: http://docutils.sourceforge.net/docs/user/rst/quickref.html.
Poderia ficar:
Será utilizada a linguagem de marcação RST (reStructuredText) para formatar e habilitar recursos de hipertexto aos documentos. Veja em Referências, sob RST.
A construção de um texto para comunicar uma ideia é um trabalho de contínuo aprimoramento. A cada dia somamos a nossas experiências novos conhecimentos, construindo e reconstruindo conceitos e, portanto, ampliando nosso pensamento.
Do mesmo modo, o texto deve ser sempre objeto de critica por parte de seu leitor e de seu revisor, buscando usar palavras simples para que a comunicação de seu conteúdo seja cada vez mais efetiva e abrangente.
Sugere-se utilizar, por exemplo, votar invés de sufragar; voltar invés de regressar, eleição invés de pleito. Simplificação sempre.
Também se recomenda evitar o uso de expressões desgastadas ou rebuscadas: a nível de, deixar a desejar, pano de fundo, encerrar com chave de ouro etc.
Sempre que uma ideia ou conceito parecer muito complexo para descrever, aconselha-se explicar cada aspecto da ideia separadamente, seguida de um exemplo.
Parágrafos contendo muitos temas ou tópicos encadeados ficam melhor organizados se dispostos como lista, podendo esta ser numerada ou não, preferencialmente com ponto e vírgula ao final de cada item, exceto pelo último.
Ex.
Contém os metadados do artigo. Seus elementos básicos são DOI, seção (de acordo com o sumário do periódico), título(s) do artigo, autor (es) e suas respectivas afiliações e notas, data de publicação, volume, número e paginação do artigo, resumo(s), palavras-chave, histórico, indicação da licença de uso Creative Commons e contagem de elementos e dados de financiamento (se houver).
Reorganizado:
Contém os metadados do artigo, cujos elementos básicos são:
- DOI;
- seção (de acordo com o sumário do periódico);
- título(s) do artigo;
- autor(es) e respectiva(s) afiliação(ões) e notas;
- data de publicação;
- volume;
- número;
- paginação do artigo;
- resumo(s);
- palavras-chave;
- histórico;
- indicação da licença de uso Creative Commons;
- contagem de elementos; e
- dados de financiamento (se houver).
Os principais problemas em relação à clareza de informação são:
- Ambiguidade – texto que permite mais de uma interpretação sobre um mesmo assunto. Nota-se este tipo de problema em uma releitura do texto;
- Redundância – texto que contém palavras que repetem o sentido de outra, tornando-o redundante, excessivo. Também pode ser identificado durante a releitura;
- “Queísmo” – utilização excessiva do pronome ‘que’ como conector em frases longas. A preferência por frases curtas elimina o problema;
- Gerundismo – uso da estrutura de frase ‘verbo auxiliar’ + ‘verbo auxiliar’ + ‘gerúndio’ (em inglês – present continuous), não existente na língua portuguesa;
- Siglas – quando usadas devem registrar seu significado na primeira ocorrência.
Algumas convenções são necessárias, como:
Se o trecho começa em caixa baixa, usa-se aspas antes do ponto. Caso contrário, aspas após o ponto.
Ex.
De modo mais específico, a Economia de Comunhão é definida como "um movimento que envolve empresários, empresas, associações, instituições econômicas, mas também trabalhadores, gestores, consumidores, poupadores, pesquisadores, operadores econômicos, pobres, cidadãos, famílias".
O ministro disse: "Não foi possível salvar a economia."
Usar o formato 00h00m.
Ex. 9h30, 14h00.
Para mais orientações de ortografia, acentuação e pontuação, encontram-se disponíveis online os seguintes recursos cujos endereços estão listados na seção de Referências:
- Vocabulário ortográfico da Academia Brasileira de Letras;
- Manual de Redação e Estilo do Estadão;
- Manual de Redação da Presidência da República;
- Manual de Redação, Estilo e Comunicação do SESC;
- Manual de Comunicação da Secom.
Encontram-se listados abaixo os termos preferidos para uso na documentação.
Conjunto de dados descrito em formato XML, referente a um ou mais artigos, gravados como um único arquivo.
Ex.: Documento XML contendo o mesmo artigo em dois idiomas distintos.
Compõe-se de uma ou duas tags que encerram um tipo específico de informação. Veja também: tag.
Ex.: <abstract>Aqui encontra-se o texto de um resumo.</abstract>
Conjunto definido de elementos com função específica de classificar, formatar, agrupar, dividir, selecionar etc, um determinado conteúdo. Do inglês: markup.
Ex.: <title>este é um título</title>, <p> <i>este texto aparece em
itálico</i></p>
Cada parte de um elemento de marcação. Há em geral duas tags para cada elemento. Entretanto, pode ocorrer um elemento vazio que pode ser representado por apenas uma tag.
Ex.: <article><id>928493</id><lock /></article>
Na descrição dos elementos, devem obrigatoriamente aparecer os seguintes itens, salvo quando especificado em contrário:
-
Nome do elemento em formato de tag.
Ex.:
<article-meta> -
Aparece em: apresenta o contexto (elemento-pai) onde o elemento ocorre, podendo ser uma lista.
Ex.:
<journal-meta> -
Atributos obrigatórios: lista somente os atributos obrigatórios ao elemento descrito. Pode vir acompanhada de valores predefinidos e/ou implícitos. Item opcional.
Ex.
@journal-id-type -
Ocorre: especifica a quantidade de ocorrências.
Ex. Uma vez
-
Descrição do elemento.
-
Exemplo(s).
-
Nota(s). (se necessário)
Esta seção descreve os tipos de formatação e sua funcionalidade no texto. A formatação em si ocorrerá utilizando a linguagem de marcação RST (reStructuredText) cuja especificação encontra-se disponível em Referências sob RST.
Todas as palavras de origem estrangeira devem ser grafadas em itálico. As que contiverem siglas adjuntas, devem ser consideradas como expressão e também assim formatadas.
Ex.
A SciELO Publishing Schema (SciELO PS) é composta pelas especificações ...
Nomes de publicações, empresas, instituições, projetos, técnicas, tecnologias, nomes de arquivos, normas, referências etc, também devem ser grafados em itálico com a finalidade de destacá-los do texto.
Ex.
FAPESP; ABNT, ISO, ReST
Identifica palavras ou termos que devem ser substituídos por conteúdo adequado fornecido pelo usuário.
Ex.:
código-do-projeto
Utilizado para exemplos, trechos de código e referências estáticas a elementos e atributos do XML.
Ex.:
<title-group>
<article-title>The teaching of temporomandibular disorders and orofacial pain at undergraduate level in Brazilian dental schools</article-title>
</title-group>
Após cada revisão efetuada deve-se alterar (ou criar) o seguinte trecho de código:
.. {"reviewed\_on": "YYYYMMDD", "by": "mail@localhost"}
Os conteúdos "YYYYMMDD" e "mail@localhost" referem-se, respectivamente à data de finalização da revisão e ao e-mail do usuário que a realizou.
- Academia Brasileira de Letras – ABL. Vocabulário Ortográfico da Língua Portuguesa. 5ª ed. 976 p. Rio de Janeiro: ABL, 2009. Acesso em 09/06/2016. Disponível em: http://www.academia.org.br/nossa-lingua/vocabulario-ortografico
- Presidência da República. Manual de Redação. 2ª ed. rev. e atual. 140 p. Brasília: Casa Civil - Presidência da República, 2002. Acesso em 09/06/2016. Disponível em: http://www.planalto.gov.br/ccivil_03/manual/manual.htm
- Senado Federal. Manual de Comunicação da Secom. Site online. Brasília: Secretaria de Comunicação Social do Senado – Secom, 2016. Acesso em 09/06/2016. Disponível em: https://www12.senado.leg.br/manualdecomunicacao
- Serviço Social do Comércio - SESC. Manual de redação,estilo e comunicação do Departamento Nacional do SESC. 2 ed. rev. e atual. 104 p., Rio de Janeiro: SESC, Departamento Nacional, 2013. Acesso em 31/05/2016. Disponível em: http://www.sesc.com.br/wps/wcm/connect/d09b4a18-b770-4130-8722-041c9e0d3ae0/MRS_2%C2%BAEdicao_148x210mm_web.pdf?MOD=AJPERES
- Zope Corporation. RST - reStructuredText. Site online. 2016. Acesso em 02/06/2016. Disponível em: http://docutils.sourceforge.net/docs/user/rst/quickref.html