O que é um arquivo de leitura?
Um arquivo de leitura é um arquivo de texto que geralmente é incluído no software que contém informações gerais ou instruções sobre o software. A natureza específica dessas informações varia significativamente de arquivo para arquivo; Um arquivo ReadMe pode conter instruções de instalação, informações gerais de uso de software, termos de serviço e outras informações legais ou qualquer outra informação relevante para o software. Quase todos os arquivos do ReadMe incluem pelo menos o nome e a versão do software, o nome da empresa ou indivíduo que desenvolveu o software e a data da publicação. No entanto, não existe uma fórmula geral para escrever um ReadMe e, no final, o conteúdo depende dos caprichos do desenvolvedor. Em muitos casos, o nome do arquivo de um arquivo de leitura será capitalizado e será chamado de "readme.txt" ou algo semelhante. Alguns programas Directories mover nomes de arquivos capitalizados para o topo de qualquer lista de arquivos; portanto, a capitalização dá destaque ao arquivo de leitura e incentiva novamente o usuário do software a ler o arquivo antes de usar o programa. Alguns arquivos de leitura são realmente intitulados "Leia -me First" ou algo semelhante para incentivar ainda mais os leitores a examinar a documentação antes de executar o software.
Um arquivo readme pode conter muitos tipos diferentes de informações de importância variável. Além de nomes e versões de arquivos, que geralmente são incluídos, os arquivos ReadMe também incluem um histórico de versões ou Changelog que lista as alterações feitas no software ao longo do tempo. Um ReadMe também pode incluir uma lista de problemas ou bugs conhecidos que afetam o uso do software. Alguns incluem informações menos essenciais, como reconhecimentos ou mensagens pessoais da equipe de desenvolvimento. Para programas particularmente simples, o arquivo readme pode atuary serve como manual do usuário que instrui um no uso geral do software.
arquivos readme elaborados são muito raros, pois os desenvolvedores geralmente preferem estabelecer as informações necessárias de maneira simples, clara e concisa. Um arquivo ReadMe geralmente é apresentado em um formato de texto simples com uma fonte padrão e sem imagens, a menos que o desenvolvedor sinta que algo mais elaborado é necessário. Essa simplicidade remove distrações desnecessárias e mantém o leitor focado nas informações. Às vezes, um arquivo ReadMe é apresentado em um "Formato de perguntas frequentes" ou FAQ. Nesse formato, o desenvolvedor prevê as perguntas mais comuns que as pessoas podem ter sobre o software e fornece respostas claras e simples, em vez de definir todas as informações técnicas em um bloco de texto que as pessoas podem ser desinclinadas a ler.