SDB:FAQ

openSUSE - Base de dados de suporte

Portal - SDB Categorias - Como redigir um artigo

Este artigo mostra as diferenças entre um artigo SDB, um Howto e um FAQ.

SDB

A SDB ou Base de dados de suporte é, a muito tempo, usada como ferramenta do openSUSE para prestar ajuda aos usuários. Para manter a SDB limpa, algumas regras devem ser respeitadas:

• Deve ser reativa. Se não houver nenhum problema, não há necessidade para um artigo SDB. Isso, entretanto, não deve impedi-lo de escrever alguma coisa fora a SDB.
• Deve ir direto ao ponto. Ser detalhada, mas tenha sempre em mente que os usuários querem uma solução rápida. Se houver mais informações: link para elas.
• Deve ser fácil. Existem várias maneiras de resolver um problema, use a mais fácil. Está certo também descrevê-la de uma forma mais avançada, e.g., linha de comando versus a forma do YaST.
• Trata-se do openSUSE. Use as ferramentas do openSUSE para resolver um problema, use o que todo mundo tem instalado. O Emacs pode ser um poderoso editor, mas não é na instalação padrão.
• A SDB não é um lugar para ser criativo, nem uma página de desenho, leia o SDB howto.
• Use o espaço de nomes SDB: e as categorias SDB adequadas.

Howto

Definição de Howto, ou guia, na Wikipédia: "Um how-to ou um tutorial é uma descrição informal, às vezes curta, de como realizar alguma tarefa específica. Um how-to é geralmente destinado a ajudar os não-especialistas, pode deixar de fora os detalhes que são importantes apenas para especialistas, e também pode ser grandemente simplificada a partir de uma discussão global sobre o tema"

Um howto lhe dá mais liberdade se comparado à SDB. Basicamente, é possível esquecer todas as regras da SDB, ou transformá-las:

• É proativo. Um HOWTO trata de algo novo' que queremos fazer com o nosso sistema openSUSE, e não sobre um problema existente que queremos corrigir. Isso é para uma Base de dados de suporte.
• É mais detalhado, explica as coisas se você quiser.
• Não há regra fácil. Tenha em mente que se você descreves as coisas fáceis, provavelmente, mais usuários serão ajudados.
• Adicione o link para a página Categoria:SDB:HOWTOs.

FAQ

Definição para FAQ na Wikipédia: Perguntas mais frequentes são as perguntas e respostas listadas, todas supostamente a ser geralmente feitas em algum contexto, e pertencentes a um determinado assunto." Pode-se dizer, assim, que se trata de Frequentes Assuntos sob Questões.

• Faça-o curto.
• Pense no que realmente são as perguntas mais freqüentes.
• Não poste FAQs de outros lugares, faça um link e deixe-o viver a montante.
• Utilize o espaço de nomes FAQ:.

Diversos

Se você não tem certeza em que categoria o seu documento está/ estará:.

• Pergunte na lista de discussão do openSUSE-wiki.
• Escreva-o sem um espaço de nomes / prefixo (as páginas podem ser movidas se necessário).
• Não tenha medo dessas regras, apenas escreva.
• No openSUSE, somos pessoas simpáticas.
• Se o artigo for movido ou alterado, isto foi feito com boa intenção.
• Se você não concordar diga ao outro editor sobre o seu ponto de vista, na página Discussão.