Results 1 to 1 of 1

Thread: [Importante!] - Como fazer um Tutorial ou Guia (Howto) eficaz

Hybrid View

  1. #1
    Moderator santiagocyl's Avatar
    Join Date
    Jun 2010
    Location
    127.0.0.1
    Posts
    86

    Exclamation [Importante!] - Como fazer um Tutorial ou Guia (Howto) eficaz

    Como fazer um Tutorial ou Guia (Howto) eficaz

    Como comunidade, encorajamos que todos os nossos membros postem guias e tutoriais sobre como usar as ferramentas do BT. Também encorajamos scripts, programas ou aplicativos, que tratem de Teste de Penetração. Dicas e truques farão com que seu post se destaque sobre os demais, e seja levado a sério.

    Primeiro, uma linguagem adequada e gramaticalmente correta é importante. Entendemos que nem todos são autoridade em ortografia ou gramática, e principalmente, que existem diferenças entre países e regionalismos próprios de cada um. Mas quanto mais você tentar esclarecer o que está postando, melhor as outras pessoas conseguirão compreender. Dessa forma, use um programa de verificação ortográfica antes de fazer sua postagem. Os mesmos estão disponíveis na maioria dos editores de texto modernos. Eles também estão disponíveis na maioria dos (se não em todos) navegadores web. É muito importante, também, evitar o uso de tradutores automáticos, eles fazem traduções confusas e inapropriadas: faça citações no idioma original, e deixe que cada usuário use o tradutor de sua preferência (lembre-se de indicar no texto qual o idioma do texto original).

    Sempre leia o que você escreveu antes de postar. Melhor mesmo é encontrar alguém que o ajude a revisar o texto. Um tutorial feito com pressa não acrescenta em nada. Pode até ser que seja melhor você salvar o rascunho do seu projeto em algum lugar, e só voltar a trabalhar nele novamente depois de algum de tempo. Isso não só lhe dá a oportunidade de limpar a mente, mas pode até ser que você encontre uma forma melhor de apresentar o seu tutorial.

    Utilização de uma fonte e tamanho de texto padrão também vale muito a pena, Usar várias fontes ou fontes de tamanhos diferentes, normalmente só vai servir para irritar o leitor. Um esquema de cores extravagante também é uma ótima maneira de fazer com que ninguém leia o seu trabalho. Texto em negrito ou sublinhado são excelentes formas de melhorar o aspecto e ajudar o seu tutorial a se destacar. Comedimento é a palavra chave para a utilização desses recursos.

    Code:
    A utilização de tags de código é uma boa idéia não só para código, mas também
    para comandos ou informações que um usuário possa ter que digitar num terminal.
    Para utilizar tags de código, selecione o texto relevante e então clique no botão 
    representado pelo símbolo #, ou use [ code ] tags ao redor do texto relevante [ / code ]. 
    É claro que sem os espaços entre os colchetes e a palavra dentro dos tags.
    Também é uma boa ideia a utilização, sem abusos, de imagens ou vídeos, afim de facilitar o entendimento do leitor sobre o que você está apresentando. Existem várias formas de fazer isto. Uma maneira simples de tirar uma foto no BT é usar o aplicativo ksnapshot, localizado no menu principal do BackTrack. Existem vários outros métodos também. O mesmo vale para vídeos, há diversos programas para captura de tela disponíveis na Internet, tanto de código livre, quanto comerciais. Vou deixar para o leitor decidir qual usar.

    Deve-se considerar também que o público alvo pode saber muito pouco sobre Testes de Penetração, ou sobre o BT. Embora esperamos que as pessoas aprendam o que está realmente acontecendo, ou o que cada comando e ferramenta está fazendo antes de começarem a seguir cegamente um tutorial, muitos não fazem isto. Por isso a quantidade de informação que você inclui em seu guia é importante. Pode ser que alguém que esteja seguindo o seu guia o procure para pedir ajuda. Se não quiser ou não puder prestar essa ajuda, pense duas vezes antes de postar ou seu guia ou deixe isto explícito no seu post.

    Por fim, outras duas coisas importantes que se deve ter em mente são, que colocando o seu material aqui no fórum, você está na verdade concordando que ele seja lido, criticado e sabatinado pelos outros membros da comunidade. Portanto, você não deve tomar nenhuma crítica que seja feita como pessoal. Elas devem ser vista como uma oportunidade de melhoria. Todos nós somos seres humanos e cometemos erros ou podemos fazer com que uma tarefa simples pareça complexa, isto faz parte do processo de aprendizado e crescimento. Então aprenda e cresça com os seus erros, se por acaso alguém os mostrar. Do outro lado da moeda, entretanto, não há a menor necessidade de diminuir os esforços de alguém, que pelo menos tentou contribuir.

    Retirado da seção Howto do fórum internacional, traduzido e adaptado por mim para o fórum em português.



    Edição em 07 Ago 2010:
    Bom pessoal, gostaria de pedir que os nossos digníssimos criadores de guias e tutoriais seguissem mais algumas simples regras adicionais, tudo do intuito de tornar o fórum um local mais organizado.

    Agrupem os tutoriais e guias num único tópico. Não dividam os guias e tutoriais em diversos tópicos; se por algum motivo precisarem fazer com que os tutoriais possuam diversas partes, criem um único tópico para o tutorial, e adicionem as outras partes como respostas a esse tópico; lembrem-se que vocês podem preparar o tutorial com antecedência e copiar e colar todas as partes de uma vez só; além do mais, sempre é possível editar os posts depois.

    Use tags nos títulos dos tutoriais e guias. Elas nos ajudam hora de realizar pesquisas, e incrementam sensivelmente a organização do fórum. As tags devem seguir a seguinte padronização:

    [Tag1] [Tag2] - Título do guia (howto) ou tutorial

    Tag1: indica o tipo de documento: tutorial, guia (howto), vídeo, artigo, ou outros, conforme explicação a seguir.

    Tutorial: espécie de guia rápido ou manual sobre uma ferramenta específica; apresenta as diversas possibilidades e opções de uma ferramenta, e descreve a utilização da mesma; o objetivo do tutorial é ensinar a utilização de uma ferramenta específica; exemplo: tutorial de utilização do netcat;

    Guia (Howto): descreve como realizar uma tarefa específica, passo a passo; uma determinada tarefa pode exigir vários passos para ser completada, e cada passo pode utilizar (ou não) uma ferramenta diferente com um conjunto de opções específicos; pode ser, inclusive, que um mesmo passo possa ser realizado de diversas maneira diferentes; o objetivo do guia é ensinar a utilização de uma técnica e não de uma ferramenta (embora você possa explicar o porque da utilização da ferramenta no passo em questão); exemplo: guia de estabelecimento de conexão reversa (pode ser feito utilizando tanto o netcat, o plink ou o ssh);

    Artigo: texto que obedece a normas de redação editorial ou científica; o objetivo de um artigo é informar o usuário sobre um acontecimento da atualidade, e no nosso caso específico precisa estar relacionado à utilização de alguma das ferramentas do back|track; o artigo pode tentar influenciar, de forma direta ou indireta, a opinião do seu leitor; por imposição das normas de redação que segue, as fontes precisam ser referenciadas no artigo;

    Vídeo: você realmente precisa de uma descrição para isso?

    Outros: qualquer texto que não se enquadre em nenhuma das classificações anteriores;

    Tag2: indica qual a ferramenta ou técnica estudada no texto que se segue; o seu uso é altamente recomendado, mas como pode ser que não esteja disponível, não é obrigatório.

    Titulo: seja criativo e divertido; um bom título é o melhor chamariz para o seu texto.

    Exemplos:
    [tutorial] [netcat] - O canivete suíço do TCP/IP
    [howto] [conexão reversa] - Se a Maomé não vai a montanha, a montanha vai até Maomé: ou como burlar firewalls sem inspeção de pacotes facilmente
    [vídeo] [mestasploit] - Criando PDF's com carga paga: o Santo Graal da engenharia social
    [artigo] - Hacking com Perl x Hacking com Python, duas opções que se complementam ou duas religiões que se excluem?
    [outros] [google hacking] - Exemplos de pesquisas interessantes, com links
    Last edited by santiagocyl; 08-08-2010 at 04:55 PM.

Similar Threads

  1. Guia Basica de como poner Back Track 4 en Español
    By PunkiD in forum Guias y Tutoriales
    Replies: 20
    Last Post: 03-22-2011, 12:09 AM
  2. [Atenção!] - Concurso Guia / Tutorial do mês de setembro de 2010
    By santiagocyl in forum Tutoriais e Howtos
    Replies: 2
    Last Post: 08-10-2010, 09:17 PM
  3. [Atenção!] - Regras do concurso Guia / Tutorial do mês
    By santiagocyl in forum Tutoriais e Howtos
    Replies: 0
    Last Post: 08-07-2010, 10:52 PM

Tags for this Thread

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •