Primer do Projeto de Documentação do FreeBSD para novos colaboradores
Anterior |  | Próxima

# Capítulo 1 Visão Geral

Seja bem vindo ao Projeto de Documentação do FreeBSD. Documentação de boa qualidade é muito importante para o sucesso do FreeBSD, e o Projeto de Documentação do FreeBSD (FDP) é a origem de muitos destes documentos. Suas contribuições são muito importantes.

A finalidade principal deste documento é explicar claramente como o FDP é organizado, como escrever e como submeter documentos para o FDP , e como utilizar de forma efetiva as ferramentas que estão disponíveis para você enquanto estiver escrevendo.

Todos são bem vindos para se juntar ao FDP. Não existe nenhum requisito mínimo para a sua associação, nenhuma quota de documentos que você precise produzir por mês. Tudo o que você precisa fazer é se inscrever na lista de discussão do projeto de documentação do FreeBSD.

Depois que você tiver terminado de ler este documento, você deve:

- Saber quais documentos são mantidos pelo FDP.

- Ser capaz de ler e entender o código fonte SGML de um documento mantido pelo FDP.

- Ser capaz de efetuar alterações num documento.

- Ser capaz de enviar suas alterações de volta para revisão e eventual inclusão na documentação do FreeBSD.

# 1.1 Conjunto de Documentação do FreeBSD

O FDP é responsável por quatro categorias de documentos do FreeBSD.

Páginas de Manual

  As páginas de manual do sistema na língua inglesa não são escritas pelo FDP, porque elas são parte da base do sistema. Entretanto, o FDP pode (e tem) reescrever partes das páginas de manual existentes para torná-las mais claras, ou para corrigir imprecisões.

  Os times de tradução são responsáveis por traduzir as páginas de manual do sistema para diferentes idiomas. Estas traduções são mantidas pelo FDP.

FAQ

  O objetivo do FAQ é consolidar (no formato de perguntas e respostas curtas) as perguntas que foram feitas, ou que podem ser feitas, nas várias listas de discussão e newsgroups dedicados ao FreeBSD. O formato não permite respostas longas e detalhadas.

Handbook

  O Handbook almeja ser um compreensivo recurso de referência online para os usuários do FreeBSD.

Web Site

  Esta é a principal presença do FreeBSD na `World Wide Web`, visível em http://www.FreeBSD.org/ e em muitos sites espelhos ao redor do mundo. O web site é o primeiro contato de muitas pessoas com o FreeBSD.

A documentação do web site, do Handbook do FreeBSD e do FAQ estão disponíveis no repositório Subversion `doc/`, que está localizado em `svn://svn.FreeBSD.org/doc/`.

As páginas de manual estão disponíveis no repositório Subversion `src/`, que está disponível em `svn://svn.FreeBSD.org/base/`.

Isto significa que os logs das alterações realizadas nestes arquivos é visível para qualquer um, e qualquer pessoa pode utilizar o svn para ver as alterações.

Em adição, muitas pessoas escreveram tutoriais ou outros web sites relacionados ao FreeBSD. Alguns destes trabalhos também estão armazenados no repositório Subversion (com a permissão do autor). Em outros casos o autor decidiu manter o seu documento separado do repositório principal do FreeBSD. O FDP se esforça tanto quanto possível para fornecer os links para estes documentos.

Anterior | Principal | Próxima
Agradecimentos |  | Antes de você iniciar

Este, e outros documentos, podem ser obtidos em ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/.

Para perguntas sobre FreeBSD, leia a documentação antes de contatar <questions@FreeBSD.org>.
Para perguntas sobre esta documentação, envie e-mail para <doc@FreeBSD.org>.