Template

Modelo de Documentação (Template) para ser usado nas documentações na wiki da Comunidade Ubuntu Brasil.

Introdução

Coloque um parágrafo com uma introdução resumindo o assunto e os principais tópicos que serão abordado na documentação e qual sua utilidade.

Primeiro capítulo/sessão

Por exemplo, instruções de instalação.

Segundo capitulo/sessão

Por exemplo, instruções de configuração.

Subtítulo

Por exemplo, passo 1 de configuração.

Subtítulo

Por exemplo, passo 2 de configuração. EX: Use o Terminal para atualizar os repositórios: Então copie e cole o código abaixo em um editor de texto:

sudo apt-get update

Terceiro capítulo/sessão

Algumas sessões podem conter apenas uma lista de links. Em alguns casos é recomendado colocar uma breve explicação do que se trata o link. Por exemplo: "Ubuntu inclui por padrão os seguintes aplicativos de Internet"

  • <Link> - Listas de links deve ter marcadores. O texto do link não deve ser em negrito. Cada link deve ser seguido por uma breve explicação sobre o mesmo.

  • <Link> - Explicações sobre os links devem ser escritas com frases completas. Veja no exemplo abaixo:

  • http://google.com.br - Um dos buscadores mais utilizados no mundo. Muitas pessoas costumam chamá-lo de "oráculo".

Mais informações

Mais informações pode ser usado para direcionar os usuários para outras fontes confiáveis ​​do Ubuntu. Por exemplo, se existe uma página sobre documentação oficial como http://help.ubuntu.com, você pode ligar para esse tipo de página. Esta sessão é opcional.

  • <Link> - Explicação do link.

  • <Link> - Explicação do link.

  • <Link> - Explicação do link.

Uma seção de links externos pode ser usada ​​para ajudar aos usuários obterem informações gerais sobre o assunto da página, como no link Time de Documentação ou uma página principal do projeto. Esta seção é opcional.

  • <Link> - Explicação do link.

  • <Link> - Explicação do link.

  • <Link> - Explicação do link.


CategoryDocumentacao CategoryTemplate

TimeDeDocumentacao/Template (last edited 2013-06-26 03:19:17 by rudineiw)