- Fórum
- xTibia - Notícias e Suporte
- Soluções
- Archived
- [ Formatação ] Aprenda A Criar Um Bom Tutorial!
HE
[ Formatação ] Aprenda A Criar Um Bom Tutorial!
Por Henrique Moura, 30 de jun. de 2010 em Archived
otserv
tibia
script
1
4.6k
Por Henrique Moura, 30 de jun. de 2010 em Archived
info
Grupo: Herói
Registrado: 17/02/08
Posts: 2.5k
Reputação: +193
Parte Um
Olá a todos os usuários!
Como vários já sabem, eu sou o responsável pela aprovação dos tutoriais desta sessão, movendo-os para sessão certa caso aprovados, ou fechando-os caso reprovados.
E durante esses dias que venho lendo os tutoriais e testando outros, percebi que a formatação dos mesmos anda péssima.
Eu poderia dizer aqui que formatar é determinar tipologia, espaçamento, entrelinhamento etc. Mas o que eu quero mostrar é a diferença entre um texto não-formatado para um que está formatado.
A primeira diferença que se é possivel notar em um texto não-formatado para um que está formatado é sua "apresentação" ao usuário. Sinceramente eu prefiro ler um tutorial no Modo 1 (veja abaixo), do que no Modo 2.
Modo 1
Tutorial da sessão de mapping do usuário Feyzer.
Modo 2
Tutorial da sessão de aprovação do usuário 951753.
Formatar NÃO é deixar seu tópico bunitinhuhh, mas sim deixá-lo agradável para quem irá ler. E isso é NECESSÁRIO aqui no XTibia.
Por isso começem a escrever na linguagem culta, não fiquem colocando nenhum tipo de linguagem internetê. Saibam colocar cores e utilizar as ferramentas do Negrito, Itálico e Sublinhado.
(quase) Finalizando nosso assunto, tópicos sem formatação serão convidados à serem alterados por seus donos. Caso isso não aconteça, será reprovado.
Parte Dois
Bom, quem me conhece sabe que eu costumo fazer sempre tutoriais relacionados a mapping, mas eu estava dando uma volta pelo forum, e eu vi muita desorganização. Muitas vezes as pessoas tem otimas idéias de tutoriais, mas não sabem como os organizarem, como criar uma interação entre o tutorial e o usuario.
Oque eu quero, é ajudar aqueles que fazem tutoriais e que gostam de ajudar os outros (como eu), a fazerem seus tutoriais de forma organizada, bem formatado, sem erros de portugês (eu tbm erro algumas vezes), e por fim, que tenha uma boa estética, oque gera uma atração maior do usuario pelo tutoria.
Então, vamos começar!
Fazendo um Tutorial
Certo, aqui você vai aprender a fazer um tutorial da melhor forma possivel, assim, você estara ajudando a você, ao forum, e aos usuarios interessados em seu tutorial.
Mas qual a forma certa de se fazer um tutorial?
Estilos de Tutoriais
Como nós sabemos existem varias areas que compoem um OtSever.
Eu particularmente faço mais tutoriais na area de mapping. Mas estarei ajudando em outras areas como Actions/Scripts
1- Tutorial de Mapping
Ao fazer um tutorial de mapping, você deve ter em mente a dificuldade do tutorial que está fazendo. O certo seria fazer o dificil se tornar facil, mas as vezes isso não é possivel. Quando for fazer um tutorial relacionado a mapping tente ao menos seguir os seguintes passo:
2- Tutorial de Actions/Scripts
Eu não tenho bastante conhecimento nessa parte de Actions, mas vale lembrar que a organização vem sempre em primeiro lugar.
Aqui nesse estilo de tutorial, é meio que impossivel não usar cores, para diferenciar cada função que a action irá exercer.
Quando for fazer um tutorial relacionado a actions ou scripts:
Eu não sou a melhor pessoa para se fazer tutoriais, mas eu sempre tento fazer da melhor forma possivel. Visando facilitar que os interessados em aprender, possam obter uma maior facilidade no aprendizado, afinal ninguem nasceu sabendo, e ninguem sabe o bastante para não precisar ver um tutorial, ou outro, mesmo que seja para buscar idéias.
Aqueles que tiverem tempo, e quiserem ver mais o menos como fazer um tutorial de mapping, poderão estar visitando os tutoriais que eu fiz, para se ter uma noção, de como fazer um tutorial organizado.
Aproveito para dizer, que estou com um projeto para a restauração de todos os Tutoriais do Forum, sendo assim, aqueles que se interessarem, poderão me enviar uma PM para maiores informações. A idéia, é pegar os tutorial que estão desorganizados, e contem conteudo de qualidade, e refaze-los, mantendo a qualidade, só que organizando-os
Espero ter ajudado a todos, qualquer duvida poste aqui, ou envie uma PM, que eu estarei ajudando na medida do possivel.
Parte Três
Passo I - A ideia
A ideia de criar um tutorial é que você tem algum conhecimento e deseja passar a outro. Porém não é simples assim, um tutorial na verdade é uma maneira de explicar algo complexo e não apenas passar algum conhecimento.
Se você criou um sistema de andar de tapete por exemplo, coloca-lo apenas no forum e explicar como se usa ele não é um tutorial e sim um script.
Porém você explicar seu codigo, seu funcionamento, sua ideia e dar outros exemplos com o qual se pode fazer com aquela base.
Passo II - Planejamento
O planejamento é essencial, isso para não ficar com informações vazadas, ai o leitor terá que percorrero todo buscando coisas que poderiam estar agrupadas e estão separadas. No inicio é legal você escreve-lo de qualquer maneira e depois ler ele e ver se tem sentido, com o tempo você estára escrevendo muito bem.
A ideia aqui é um otimo tutorial, não um que terá 2 comentarios e será esquecido pelo mundo.
Passo III- Linguagem
A linguagem é essencial, dependendo do nivel dele algumas pessoas não entenderão termos tecnicos ou girias da internet.Evite também girias regionais pessoas de todo o Brasil e até estrangeiros irão ler ele. Uma pessoa me dizia que você deve escrever um tutorial pensando no seu amigo mais retardado e fazer uma maneira de ele entender. Porém cuidado, pois um leitor mais inteligente pode ficar ofendido. Ler varias tutoriais ajuda a ter uma linguagem da internet, que é compreendida desde a Hackers até senhoras de 90 anos.
Passo IV - Vocabulario
Eu comecei a usar esse vocabulario, para tentar ajudar as pessoas a compreenderam certos termos que não tem como serem retirados de certos tutorias. Nele você explica resumidamente ele para pessoas que não querem ler ele por completo ou buscam apenas algumas informações.
Passo V - Exemplos
Os exemplos são essenciais, dizem que as pessoas aprendem de 3 maneiras : Ouvindo, Fazendo ou Olhando alguem fazer ou tentando fazer. Eu sou o terceiro caso eu tenho que fazer algo feito para conseguir entender, portanto você deve sempre exemplificar da maneira mais clara possivel o que está sendo explicado com fotos ou codigos.
Passo VI - Divisões
Um tutorial deve ser dividido como uma redação, primeiro você da a introdução, ai quem não quer saber do assunto ou confudiu o titulo já pode sair. Algumas pessoas gostam de fazer um sumario (ou indice) coisa que eu não gosto mais ajuda muito.
Passo VII - Imagens
As imagens em certos tutorias são tudo, um topico so com palavras para pessoas inexperientes pode ser totalmente chato e cansativo e provavelmente ela lerá sem animo e não aprenderá nada. Procura colocar imagens no formato JPEG ou PNG que são leves e com boa qualidade de cor. Lembre-se que nem todos tem internet rapida e muitas fotos poderão não carregar deixando o tutorial sem sentido. Portanto também não exagere na quantidade de fotos.
Passo VIII - Codigos
Os codigos em certos tutoriais são mais importantes que as imagens, eles devem estar entre as tag code, que deixa ele bem formatado deixando ele mais claro. Veja quando usar CODE e QUOTE
function onUse(cid, item, frompos, item2, topos) gspos = {x=933, y=928, z=12} if item.itemid == 7537 and item.actionid == 5500 then doSummonCreature("Giant Spider", gspos) doTransformItem(item.uid,7536) doDecayItem(item.uid) end endO code mantem o alinhamento do codigo deixando ele mais claro, sendo sempre END embaixo do IF correspondente.
Porém foi criado para poder se colocar codigos nativos de navegadores, portanto não aceita formatação. Recomendado para o codigo inteiro ou grandes trechos.[/i]
Esse não mantem o alinhamento, porém aceita formatação é melhor para explicar uma ou duas linhas de codigos.
Passo IX - Produzi-lo
Bem depois de se pensar muito, deve se cria-lo, no começo como ja dito é bom ter esse planejamento, é igual dirigir no começo você pensa em colocar o cinto, colocar a chave na ignição, deixar em ponto morto...
Depois você ja faz automatico. Portanto escreva-o como vier na sua cabeça.
Eu crio os meu tutoriais no NOTEPAD ++, tem gente que cria no WORD ai depois você joga no navegador, eu acho melhor pq varias vezes a net caiu ou o pc reiniciou e me deixou muito feliz...
Passo X - Revisão
Depois de faze-lo chegou a hora da revisão, você terá que reler e ver se tem erros, repetições, coisas absurdar ou algo do tipo. Depois de um tempo você nem erra mais, mas é sempre bom verificar.
Passo XI- Formatação
Depois de te-lo "pronto" chegou a hora de formatar, essa parte é importante tente usar cores que não ceguem o usuario e letras que ele possa enxergar. Pelo amor de deus não entupa o tutorial de emotions, pois o deixa muito infantil. Usar varias fontes é muito bom, apesar de eu não gostar disso, deixa ele mais atraente. Negrito use apenas em titulos, sub titulo e palavras importantes.
Use QUOTE para dar enfase ao final de cada trecho.
A tag SPOILER é muito interessante para esconder os codigos, porém alguns leitores não sabem apertar botões e perguntam aonde está o codigo.
E lembre-se todos titulos mesma fonte tamanho e cor, sub titulos mesma coisa, não faça um arco-iris e sim algo legivel
Passo XII - Humor
Um topico como esse enche o saco para a maioria das pessoas, portanto sempre faça um humor basico, isso mesmo que seja imbecil faz o leitor voltar a atenção para o topico e não apenas ler ele. Lembre-se você quer ensina-lo e não apenas receber comentarios e fama.
Passo XIII - Conclusão
Essa parte é importante, pois algumas pessoas so leêm o inicio e a conclusão e colocam um comentario tosco.Experimente colocar algum erro no meio do tutorial e um no começo. Você vai ver quem leu ele de verdade e vai se divertir vendo as pessoas que disseram ter lido todo. Sempre peça comentarios, por mais que você seja anormal o principal motivo de se fazer isso é mostrar que você tem conhecimento e está disposto a expor ele. Coloque sempre creditos de fontes ou pessoas que te ajudaram.
Passo XIV - Titulo
O titulo é o que vai atrair as pessoas, eu por costume coloco o titulo depois de cria-lo todo e rele-lo, isso faz ele ter nexo com o conteúdo, e não ter cara de japonês e ser africano.
Passo XV - Finalização
É sempre bom manter um padrão do tipo de tutorial para que quem goste do seu estilo possa sempre procurar seus tutoriais. Sempre evolua, mas nunca mude sua maneira de faze-lo.
Bem, agora você criou seu tutorial, não espere receber chuvas de comentarios alguns tutoriais apesar de serem muito interessantes são de assuntos pouco populares. Saia com a ideia " Se eu ajudei 2, já estou feliz". As vezes seu script ou tutorial mais "imbecil" é o seu mais famoso. E lembre-se OTSERVER não te deixa rico, faça por diversão ou como eu para aprender a base de outras linguagens corporativas.
Então se você leu tudo isso, já tem um bom cacife para fazer um X-Tutorial e sempre te-lo no topo.
E pelo amor :heart: nunca deixe isso no seu tutorial
Espero que isso seja util, e ajude as pessoas a criarem melhores tutoriais.
Parte Quatro
Olá, venho aqui apresentar um tutorial de Formatação de letras, mais para os membros que acabaram de chegar ao fórum, usando essas dicas você pode crescer rapidamente sem outros membros falarem que seus tópicos são virus pela baixa quantidade de post's e o pessoal não ira de chamar de polonês pelos erros "graves" Ortograficos.
A forma como o texto é apresentado ao visitante é um dos principais fatores que influenciam na decisão entre ficar e ler o texto ou ir embora e não voltar mais.
Algumas das minhas dicas são:
Cores- As cores devem entrar em contraste com o fundo, o normal são letras pretas em fundo branco ou vice-versa.
Evite cores conflitantes que sejam difíceis de ler, como fundo roxo com letras amarelas.
Tamanho- Enquanto estiver escrevendo, o próprio editor de sites que estiver utilizando se encarregará de cuidar do tamanho ideal.
Se precisar alterar este tamanho por algum motivo, evite diminuir muito, ou terá que entregar uma lupa aos seus visitantes.
Caso esteja em dúvida, no Dreamweaver 8 por exemplo o tamanho padrão é 13 px, já no Front Page a medida padrão é 3.
Obs: Ambos utilizam medidas diferentes.
Escreva textos com Letras- Muitos webmasters tem o hábito de escrever seus textos utilizando imagens.
É muito comum ver menus e até o conteúdo ou parte dele feito por imagens.
Em alguns navegadores é possível desativar o carregamento de imagens para tornar a navegação mais rápida, o que poderia atrapalhar a navegação. Além de que ao utilizar imagens no lugar de textos você fará com que seus visitantes tenham que esperar mais tempo para que a página seja carregada no navegador.
Dica-
Evite ao máximo utilizar imagens de fundo em locais onde os textos irão ser apresentados.
É muito difícil encontrar uma combinação adequada entre a cor do texto e as cores da imagem, isso poderá tornar o texto ilegível para muitos.
Erros de Ortografia - Este é mais um dos fatores que podem influenciar o visitante na decisão entre ficar e ler o resto do conteúdo ou deixar o post e nunca mais voltar.
Após escrever um texto em seu post, verifique se não existem erros de escrita e se o texto está coerente.
É muito comum pelo menos para mim escrever textos que no momento me pareceram coerentes, mas que após uma relida me fizeram sentir vergonha de ter escrito, e pior ainda é quando eu descubro erros depois de ter enviado para o site.
Para verificar se as palavras do texto estão escritas corretamente eu costumo utilizar um corretor online, o Flip5.
Alguns erros de ortografia são toleráveis, mas evite exagerar!
AUTORES: REDLZ, PAIN, LORDZ, TIBIAA4E