Você está aqui: Página Inicial Documentação How-Tos Como usar este recurso
Ações do documento

Como usar este recurso

Este How-To se aplica a: Qualquer versão
Este How-To é pretendido para: Todas as Pessoas

Bem vindo ao Centro de Ajuda! Aqui você terá um modo diferente do que está acostumado para fazer documentação, então por favor leia este documento para entender melhor como contribuir.

Início Rápido

Para o impaciente, aqui está o mínimo que deverá saber:

  • Você normalmente precisa estar logado.
  • Há vários tipos diferente de documentação, muitos são auto-explanatórios,  mas preste atenção para a dirença entre um How-To e um Tutorial (explicado abaixo).
  • Para adicionar alguma documentação/ajuda, vá para a seção relevante, tenha certeza que já não há nenhuma entrada para oque você quer adicionar, e use o botão  acima a direita para adicionar (normalmente falando Adiconar FAQ ou similar).
  • Adicione seu conteúdo e salve-o. Este ciclo de editar/visualizar pode ser feito quantas vezes você quizer até que esteja feliz com o resultado.
  • Tenha certeza que você Enviou seu documento para publicação quando terminar -  o  pulldown Enviar acima à direita  na aba Edição.
  • Um revisor irá pegar o documento e publicá-lo a não ser que o conteúdo precise ser alterado.
  • Se alguém adicionar comentário para sua entrada mais tarde, você será notificado por email.

Que tipo de item é minha documentação?

Abaixo está a descrição, uso e exemplo de cada tipo.


Frequently Asked Question (FAQ)
Um FAQ é uma questão curta com uma resposta de um a dois parágrafos. Você pode adicionar várias questões para um area de FAQ e agrupar questões em seções:
    Exemplo de FAQ
Questão: O que é Plone?

Resposta:
Plone é um Sistema de Gerenciamento de Conteúdo (ECM/CMS)
que é executado acima de Zope e CMF.
HowTo
Um HowTo é uma descrição de uma página em como realizar algo, mas é folderish, assim Arquivos/Imagens podem ser anexadas. Normalmente é muito breve e direto ao ponto.

How-Tos típicos:
  • Como executar Plone com Servidor Web Apache
  • Como alterar as abas que aparecem no topo do portal

Tutorial
Um tutorial é um artigo de várias páginas e  com muitos detalhes. O tutorial aborda um assunto em produndidade e pode pode conter aspectos conceituais de uma tarefa, em adição para passos práticos para ter o trabalho pronto.
 
Se você se sente inseguro sobre a diferença de um How-To e um Tutorial, pense sobre a diferença entre um documento que somente ensina os ingrediente necessários e como fazer um bolo (How-To), e um artigo article que lhe diga sobre a história por trás dos bolos em geral que podem ou não ensina-lo como fazer um (Tutorial).

 
Tutorials típicos:

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

Manual de Referência
Um manual de referênia é uma peça definitiva de documentação de algum produto ou tecnologia e tende a ter muitíssimas página, com seções quebrando o conteúdo. Este é o tipo de documentação mais rara.

Link Help
Um link help é um link (que pode ser externo ou interno). Ele é diferente de um link Plone padrão no que ele pode ter uma seção e informação sobre versão.

Links Help típicos:

  • O Livro do ZOPE em zope.org
  • Manual de Referência do CSS em W3C.
 
Referência de Erros
Uma referência de erros tem a intenção de ser a explanação e um erro em particular, com detalhes sobre como corrigí-los se relevante.

Referência de Erro Típicas:

  • Sequência prevista, veio inteiro
  • FS Page Template há erros: Falha na Compilação
 
Glossário de Definições
Um glossário de definições descreve um termo em particular usado tão conciso quanto possível.

Glossário de Definições Típico:

  • CMF: Sistema de Gerenciamento de Conteúdo
  • Workflow: Automoção de um processo de negócios
por Jean Rodrigo FerriÚltima modificação 08/06/2006 21:00 Creative Commons

O conteúdo deste site está sob licença Creative Commons