Início Rápido

• Você normalmente precisará estar logado.
• Há diversos tipos diferentes de documentação, a maioria são auto-explicativas, mas merecem atenção as diferenças entre um How-to e um Tutorial (explicado abaixo).       
• Para adicionar um item de documentação/ajuda, acesse a seção correspondente ao item, certifique-se que já não exista um item sobre o que você quer adicionar, e use o menu pulldown no canto direito superior para adicionar ítens (normalmente escrito como 'Adicionar FAQ' ou similar).        
• Adicione seu conteúdo, e salve-o. Este ciclo de edição/visualização pode ser realizado quantas vezes você quiser, desde que você esteja feliz com o resultado.       
• Tenha certeza de submeter seu documento para publicação quando você estiver pronto - menu pulldown superior direito na área de conteúdo.
• Um revisor irá analisar o documento, e publicá-lo, a menos que o conteúdo precise ser melhorado.
• Se alguém adicionar comentários a sua entrada mais tarde, você será notificado por e-mail.

Que tipo de item é minha documentação?

Abaixo está uma descrição, uso e exemplo para cada um dos tipos.

Perguntas Mais Frequentes (FAQ de 'Frequently Asked Question')

Um FAQ é uma pequena pergunta com uma resposta de 1 a 2 parágrafos. Você pode adicionar diversas perguntas a uma área de FAQ e agrupar as perguntas em seções:

    Exemplo de FAQ
    Pergunta: O que é o Plone?

    Reposta:    
    Plone é um robusto sistema gerenciador de conteúdos (ECM/CMS) de código
    livre que roda sobre o Zope e CMF.

HowTo

Um HowTo é uma descrição de uma página sobre como realizar algo, mas é 'folderish', então Arquivos/Imagens podem ser anexados. É geralmente muito breve e vai direto ao ponto.

How-Tos típicos:

• Como instalar o Plone com o Servidor Web Apache
• Como mudar as abas que aparecem no topo do portal

Tutorial

Um tutorial é um artigo de múltiplas páginas com muitos detalhes. O tutorial é mais específico que um How-to, e pode cobrir os aspectos conceituais da tarefa, com a adição de demonstrações práticas sobre como realizar determinado trabalho.

Se você não estiver muito certo sobre a diferença entre um How-to e um Tutorial, pense sobre isto como a diferença entre uma receita que lhe ensine somente quais ingredientes são necessários, e como assar o bolo (How-to), e de um artigo que conta a você sobre a historia por trás dos bolos em geral, que pode ou nao lhe ensinar como assar um (Tutorial).

Tutoriais típicos:

• Como utilizar workflows em seus projetos
• Porque separar conteúdo, lógica e apresentação?

Manual de Referência

Um manual de referência é uma peça definitiva da documetação para alguns produtos ou tecnologias, e tende a ter diversas páginas de comprimento, com seções separando o conteúdo.

Link de Ajuda

Um link de ajuda é um link (qualquer um externo ou interno). Ele é diferente de um link Plone padrão, pois, pode ter seções e informações de versão.

Links de Ajuda típicos:

• O Livro do Zope em zope.org
• Manual de referência do CSS em W3C

Referência de Erro

Uma referência de erro é uma explicação de um erro particular, com detalhes sobre como repará-lo, se isso for relevante.

Referência de Erro típica:

• Expected sequence, got integer
• FS Page Template has errors: Compilation failed

Definições do Glossário

Uma definição do glossário descreve um termo particular usado, tão brevemente quanto possível.

Definições do Gossário típicas:

• CMF: O Framework de gerenciamento de conteúdo
• Workflow: Uma estrutura de máquina de estados usada para modelar processos comerciais