Firebird Documentation Index → Guia de escrita → Preparando-se para escrever |
É sempre uma boa idéia pazer um resumo antes de escrever o texto propriamentedito. Preparar um resumo ajuda você a "ficar organizado"; isso reduz a chance de esquecer alguma coisa vital, e faz o próprio trabalho de escrever muito mais fácil.
Você pode seguir estes passos quando fizer um resumo:
Defina exatamente o que você deseja que seus leitores aprendam com o seu trabalho.
Divida a matéria do assunto em unidades lógicas - capítulos e / ou seções e / ou sub-seções.
Tenha certeza que a ordem das unidades faça sentido, especialmente para um passo-a-passo, tutorial e / ou guia do usuário. Assim: arrume as unidades de forma que se algo tiver de ser feito (ou entendido) primeiro, esse algo apareça primeiro em sua documentação.
Mostre seu resumo na lista firebird-docs no sourceforge.net e pergunte por comentários.
Quando estiver satisfeito com seu resumo, examine-o inteiramente e decida se você já tem toda informação básica para iniciar a escrita. Numa situação ideal, você deverá contar com toda a informação necessária antes do início da escrita, porque em alguns casos uma peça de informação anteriormente desconhecida pode fazê-lo escolher uma estrutura de documento diferente. De modo que é bem melhor ter esta informação ainda na fase de resumo.
Firebird Documentation Index → Guia de escrita → Preparando-se para escrever |