Recomendação para a escolha de nomes de arquivo
Arndt von Staa
LES - Laboratório de Engenharia de Software
Departamento de Informática
Pontifícia Universidade Católica
22453-900 Rio de Janeiro,
Brasil
Relatório LES
Julho 2008
© Arndt von Staa
Arndt_RecomendacaoNomeArquivos_20080730.doc
14 agosto 2009
Recomendação para a escolha de nome de arquivo
1. Motivação
É enorme o número de arquivos que se recebe e manipula em uma universidade. Infelizmente muitos dos arquivos que se recebe constituem SPAM. Além disso, os nomes gerados automaticamente por sistemas tais como o MS-Word tendem a ser ruins. De maneira geral é
comum deparar-se com arquivos cujos nomes nada significam, obrigando-nos a abri-los para
saber do que tratam. Nomes ruins também aumentam o trabalho para encontrar o arquivo
que procuramos. Exemplos de nomes sem significado:
•
00056422.pdf
•
farchi.pdf
•
trabalho.zip
•
PropostaFinal.doc
•
Gutachten-07.doc
Quando se trabalha em grupo envolvendo um mesmo arquivo, é interessante dispor-se de
um controle de versão para que se possa evitar o uso de versões incorretas.
Deseja-se, então, dispor de um padrão de escolha de nomes com as seguintes características:
•
informar o projeto, pessoa, ou curso ao qual se relaciona o arquivo;
•
facilitar a identificação do que trata o arquivo;
•
quando for o caso, informar o congresso ou periódico para o qual foi enviado o arquivo;
•
informar a versão do arquivo;
•
informar quem gerou a versão em questão.
Com um bom sistema de identificação, reduz-se em muito a chance de perdas decorrentes de
exclusão acidental. Facilita-se encontrar visualmente o arquivo procurado. Facilita-se separar
SPAM e dos arquivos relevantes. Também torna possível o acompanhamento da evolução de
um artigo ou artefato. Evitam-se, assim, os problemas decorrentes do uso de versões defasadas.
2. Padrão para nome de arquivo
Os nomes de arquivos devem obedecer à seguinte sintaxe:
<Projeto>_<Autor>_<nome representativo>_<ano><mm><dd>_<rev>.<ext>
<Projeto> é opcional, informa a sigla do projeto, curso, conferência ou periódico
com o qual o artigo se relaciona. Pode um nome ser composto.
<Autor> identifica quem escreveu ou é responsável pela manutenção do arquivo.
Deve ser usado o nome pelo qual a pessoa é conhecida. No caso de grupo, pode ser formado por uma seqüência de identificadores dos membros do grupo, cada identificador formado pelas iniciais dos nomes do
correspondente membro do grupo.
1
Recomendação para a escolha de nome de arquivo
<nome representativo>
é um nome que identifica a natureza ou o assunto do que trata
o arquivo.
<ano> quatro dígitos do ano, ex. 2007
<mm> dois dígitos do mês (ex. março é 03)
<dd> dois dígitos do dia do mês (ex. o quinto dia do mês é 05)
<rev> opcional, identifica o último revisor da versão. Sugere-se que sejam usadas duas a três letras com as iniciais identificadoras da pessoa.
<ext> é o nome de extensão (tipo) do arquivo.
Para evitar problemas na transmissão e de portatilidade, o nome do arquivo não deve conter caracteres em branco nem caracteres diacríticos (letras acentuadas ou cedilhas). Deve
conter apenas um único caractere ponto (‘.’) e isto para separar o nome da extensão. Deve-se
utilizar sublinhado (“_”) ao invés de hífen (“-“). Desta forma evitam-se erros do sistema
Windows (de vez em quando duplica arquivos quando o nome contém ‘ã’), e os nomes não
geram confusão ao serem enviados para sistemas UNIX ou LINUX. Por falar em LINUX, caixas alta e baixa devem ser usadas de forma consistente, uma vez que em LINUX e UNIX os
nomes são sensíveis a caixa, exemplo: Abc.doc e abc.doc nomeiam dois arquivos diferentes.
Exemplos de nomes de arquivos:
•
INF2135_ Monografia_ JoseSilva_20090814.zip
•
INF1314_Trabalho1_JSMEF_20090814.zip
♦ INF1314_Trabalho1 é o projeto
♦ JS – José Silva
♦ MEF – Maria Ermengarda Filarmonia
•
FAPERJ_ProjetoXPTO_Proposta_20060530.doc
♦
•
Projeto submetido à FAPERJ
Prestação de contas do projeto submetido à FAPERJ
FAPERJ_ProjetoXPTO _JoséSilva_Relatorio2_20070330.doc
♦
•
em que:
FAPERJ_ProjetoXPTO_PrestacaoContas_20070330.doc
♦
•
INF2135_ Monografia é o projeto
Segundo relatório do bolsista José Silva do projeto XPTO submetido à FAPERJ
Fritz_Franz_Recomendacao_20010101.doc
♦
Carta de recomendação escrita por “Franz” a respeito de “Fritz”. Dessa forma todas as cartas que envolvam uma mesma pessoa ficam juntas.
•
Fritz_CCD_DI_ParecerAdmissao_20010101.txt
•
Fritz_CCD_DI_ParecerPromocao_20070_01.doc
•
Jose_Dissertacao_20070803_avs.doc
♦
•
Dissertação redigida por José cuja versão de 3/8/2007 foi revisada por “avs”.
Chen_MetamorphicTesting_SPE.pdf
♦
•
OBS. use “_” ao invés de “/” em “CCD/DI”
Paper redigido por “Chen” sobre o assunto “metamorphic testing” e que se encontra no periódico SPE (Software Practice and Experience).
SBES07_Jose_TesteSistematico_20070228.pdf
2
Recomendação para a escolha de nome de arquivo
3. Discussão
A presente recomendação sugere como escolher nomes de arquivos, facilitando o reconhecimento do conteúdo do arquivo a partir do seu nome. Evidentemente é difícil prever todas as
possibilidades de conteúdo de arquivos. Entretanto, espera-se que a recomendação deixe claro que o espírito da escolha do nome de um arquivo deve contemplar a facilidade de se determinar o seu conteúdo ao ler o seu nome. Deve, ainda, prover a facilidade de se agrupar os
arquivos segundo algum critério:
•
Os arquivos que envolvem as mesmas pessoas, agências etc. ficam agrupados;
•
Os que correspondem a diferentes versões de um mesmo arquivo estarão juntos e ordenados cronologicamente.
Com esse espírito em mente é fácil fazer as necessárias adaptações para casos específicos, reduzindo-se muito o trabalho de manutenção das pastas contendo um volume grande de arquivos gerados por uma variedade de pessoas.
3