Manual do Ubuntu/Instruções para colaboradores

Este documento define regras para ajudar na escrita do Manual do Ubuntu.

Metodologia para a escrita do texto

Recomendamos adotar os seguintes passos em sequência para escrever o texto: 1. Escrever os títulos de capítulo, seções e subseções 2. Para toda seção/subseção, escrever uma lista de tópicos sumarizando o conteúdo do que será detalhado depois em cada parágrafo. Os tópicos podem partir de um conceito mais geral para um mais especifo, mostrar uma relação de causa e efeito ou descrever um sequência de ações. 3. Incluir comentários sobre dicas e alertas 4. Elaborar e escrever uma lista exercícios para cada seção

Sobre o estilo do texto

O texto deve ser escrito como se o autor estivesse conversando com o leitor. Deve ser utilizado, assim, o termo "você" se referindo ao leitor. Além disso, o texto deve adotar uma linguagem simples que possibilite tanto um leitor de 11 a 100 anos de idade entendê-lo. Deve ser assumido, contudo, que o leitor possui conhecimentos básicos de informática e de Internet (sabe manipular programas de computador, pastas e arquivos, consegue navegar e pesquisar na internet, sabe ler e enviar emails com anexos, tem domínio de algum editor de texto e sabe manusear arquivos de áudio e de imagem).

Cada conteúdo diferente deve ter uma imagem ilustrativa junto com o seu texto. A imagem deve mostrar apenas as informações realmente necessárias para o entendimo do conteúdo. Como exemplo, a descrição da barra de ícones do Ubuntu deve ser acompanhada de uma imagem apenas dessa barra.

Sobre as imagens

Todas as imagem devem ser geradas a partir de uma tela com resolução 1024x768 pixels. Nomes de usuários, de pastas e de arquivos na imagem devem ser trocados por nomes genéricos, que não identifiquem nenhuma pessoa em particular. Desta forma, a descrição da configuração de uma conta de usuário pode ser feita supondo um usuário de nome "Teste" ou simplesmente "Usuário".

As imagens devem ser salvas com qualidade suficiente para futura edição e visualização.

As imagens devem aparecer no documento centralizadas e com um rótulo em baixo. Elas devem ser numeradas, se possível.

A visualização da imagem na página deve ter qualidade e tamanho suficientes para permitir sua perfeita visualização quando a página é ampliada ocupando a largura da tela do computador.

Sobre a configuração do sistema Ubuntu

O manual deve ser escrito considerando uma configuração padrão básica do Ubuntu. Isso significa que o sistema terá o papel de parede padrão, uma única conta de usuário e apenas os pacotes que já são instalados automaticamente. Na medida em que for necessário demonstrar outros recursos do Ubuntu, mais pacotes (como o Ubuntu-restricted-Extras) poderão ser instalados e ferramentas reconfiguradas, mas tais alterações devem estar claras no manual de modo que permite sua reprodução pelo leitor.

Dicas e Notas de alerta

Dicas que expandam a explicação já dada no texto sobre um determinado assunto odem ser inseridas na página. Elas devem aparecer em uma área retangular lateral com bordas arredondadas e contendo um símbolo próprio (representativo de dicas). O mesmo vale para notas de alerta sobre assuntos que demandam maior cuidado do usuário a fim de não cometer erros.