Firebird Documentation Index → Guia de escrita
Firebird Home Firebird Home Firebird Documentation IndexPróxima: Onde os documentadores se encontram

Guia de escrita de documentação para o Firebird

Paul Vinkenoog

Fabrício Araújo

Tradução para o Português do Brasil

26 Mar 2005 – Documento versão 1.1-pt_br


Índice

Introdução
Onde os documentadores se encontram
Achar um assunto
Preparando-se para escrever: faça um resumo!
DocBook XML - uma introdução
Ferramentas para criar documentos DocBook XML
Escrevendo seu documento DocBook
Aspectos do processo de escrita não relacionados com o DocBook
Adicionando seu documento ao módulo de manuais
A. História do Documento
B. Aviso de Licensa

Introdução

Propósito deste documento e público-alvo

Este documento discute os vários aspectos of escrever documentação para o Firebird. É destinado a pessoas que desejam ajudar a escrever documentação para o projeto Firebird, ou quem pelo menos considera seriamente fazer isto. Após esta leitura, você deve o conhecimento necessário para começar a escrever documentos para o Firebird em nosso formato escolhido, o DocBook XML.

Pré-requisitos

Antes de começar a ler este documento, certifique-se que você sabe:

  • O que é o módulo de manuais do Firebird

  • O que é o CVS, e como se usa o cliente CVS para baixar o módulo de manuais corrente

  • Como gerar a documentação atual do módulo de manuais que você baixou

Este conhecimento é essencial se você irá contribuir com o nosso projeto de documentação. Se você se sente inseguro sobre algum desses pré-requisitos, então leia o primeiro o Howto Gerando as manuais Firebird e depois volte a ler este texto.

Tópicos discutidos neste documento

Começaremos com alguns capítulos curtos sobre:

  • A lista de discussão firebird-docs

  • Achar um assunto

  • Fazer um esboço para o seu documento

Depois disso, iremos gastar algum tempo para explicar os conceitos básicos do DocBook XML, porque este é o formato em que desejamos que você nos entregue os seu(s) documento(s). Os tópicos discutidos incluem:

  • O que é o DocBook XML

  • Razões para a nossa forte preferência ao DocBook em detrimento de outros formatos

  • Ferramentas que você pode utilizar para produzir textos em DocBook

Não se preocupe se o DocBook não significa nada para você ainda: o conhecimento requerido pode ser aprendido em menos de uma hora, e há uma boa chance de que você pode se beneficiar deste conhecimento em outros projeto, quando você tiver que escrever documentação técnica.

A próxima parte sobre escrever os documentos inclui:

  • Configurando o próprio documento

  • Usando elementos do DocBook

  • Algumas notas sobre linguagem e estilo de escrita

  • Direitos autorais e a Licensa de Documentação Pública

  • Usando os documentos do PostgreSQL como base

Finalmente, nós mostraremos como adicionar seu documento finalizado ao projeto Firebird. Os tópicos principais desta seção são:

  • Submetendo seus documentos ao módulo de manuais

  • Onde pedir para ter direitos de submissão se você não os possui

  • O que se pode e não pode assim que você recebeu seus direitos de submissão

Firebird Documentation IndexPróxima: Onde os documentadores se encontram
Firebird Documentation Index → Guia de escrita