IXCwiki:Treinamento Wiki Like A Boss

Padlock-black.svg
Esta página foi protegida pelo autor. Não edite.
Info talk.png
Este manual é um aditivo ao Manual de como se fazer um manual.
Oculos-opressor.png


Este treinamento tem como objetivo explorar as possibilidades da wiki trazendo manuais técnicos com conhecimentos sobre a utilização das ferramentas que disponibilizamos uso aos nossos clientes.
Conhecimento é o maior patrimônio que existe! Vamos compartilhar o nosso.

Ideia.png Mas antes deixa eu passar um histórico


Geração de índices

Essa é uma dúvida recorrente. Existem muitos manuais muito grandes na wiki que estão sem índice.
O objetivo do índice é fazer com que o pesquisador chegue rapidamente na seção do artigo que fala aquilo que ele precisa. A criação dos índices facilita a pesquisa e agiliza a resolução de problemas. Para gerar o índice, é necessário criar a árvore de tópicos dentro do artigo utilizando-se da formatação de subtítulos.

Ideia.png Nunca usamos ==, ou seja, Título.



Vejamos a árvore de índice sendo formada:

Subtítulo

Para um subtítulo, utiliza-se esta sintaxe wikitexto: ==Subtítulo==
Subtítulos são muito úteis para dividir um manual que contenha muitos passos em seções, porém ao invés de usar os nomes passo 1 ou passo 2, use 2 ou 3 palavras que remeta o objetivo daquela seção; o que usarmos aqui vai aparecer no índice.

Tópico

Para um tópico, utiliza-se esta sintaxe wikitexto: ===Tópico===
Tópicos são pontos importantes dentro de uma seção.
Também podem ser usados para nomear as abas de um formulário

Subtópico

Para um subtópico, utiliza-se esta sintaxe wikitexto: ====Subtópico====
Subtópicos são passos dentro de um tópico, ou referências a campos dentro de uma aba de formulário.

Info talk.png
Veja um exemplo de árvore de índice no tutorial MIKROTIK
Ideia.png É possível mover o índice para a direita usando a predefinição
{{TOC-Direita}}



Ideia.png É possível forçar o índice usando a predefinição
{{índice}}



Uso de formatação

Invocaremos as dicas do Manual de como se fazer um manual sobre formatação:

Formatação de texto

  • Usamos negrito sempre que citamos um caminho de menu do sistema, apontando os submenus com o símbolo maior que (>). Exemplo: acesse o menu Cadastros > Clientes > Clientes. Também usamos negrito quando queremos citar um campo, aba, form ou grid do sistema. Exemplo: Preencha o campo Razão da aba Clientes, que está no form Clientes.
  • Usamos itálico quando citamos parte de um texto de outro autor ou conteúdo, quando queremos dar enfase a uma palavra ou ainda quando queremos usar termos estrangeiros.
  • Usamos underline (sublinhado) quando queremos dar enfase a um ponto ou passo importante do manual. Exemplo: é necessário que se sigam as instruções deste manual para que a nossa wiki fique cada vez melhor.

Usos fora deste padrão devem ser corrigidos.

Mais informações sobre estilos consulte o Livro de estilos

Dicas

  1. Não utilizar muito negrito, principalmente em títulos, pois os mesmos já são destacados por padrão.
  2. Não utilizar itálico em títulos, jamais.

Uso de Links e interlinks

Se a wiki é o bolo, os interlinks são o recheio.

Interlinks

Sempre que houver possibilidade de interligar os manuais use a sintaxe [[Link|Nome do Link(se houver necessidade)]] para isso.

Links externos

Se houver um tutorial externo que faça sentido ser invocado no seu manual, use a sintaxe [http://link.com.br/link/link.php Nome do link]

links do youtube

É possível invocar links do youtube no formato vídeo embed usando a sintaxe <youtube>tV_4G8wJxPs</youtube>

Predefinições

Kisspng-.png

Aqui que começa o território Like a Boss.
Se a wiki é um bolo, as predefinições são os morangos
Aqui nesta página eu já usei várias predefinições.

Ideia.png Olá, eu sou o resultado de uma
predefinição.


Broom icon.svg
E eu sou resultado de outra predefinição

Podemos criar uma nova predefinição baseada em outra predefinição, por exemplo temos esta que estou inserindo nos menus que tenho revisado: {{Menu}}

EasyGestures PieMenu.png
Esta página é uma página de menu ou submenu.

Ela segue a mesma lógica do menu do sistema IXCprovedor
Alterações no menu do sistema são documentadas na página de discussão.

Existem milhares de predefinições na Wikipedia em português. Se sentir falta de alguma é possível instalar.

Info talk.png
Predefinições devem ser instaladas em Predefinições:Nome_de_sua_predefinição
  • Substitua Nome_de_sua_predefinição pelo nome de sua predefinição
  • Para Predefinições filhas (criadas sobre outra predefinição), use Predefinições:Nome:Subnome
  • Bloqueiem suas predefinições
Ambox warning pn.svg
Nunca edite uma predefinição existente.

Se você localizar uma predefinição que não esteja protegida, informe na discussão da predefinição para que o criador da mesma coloque a devida proteção nela. Predefinições editadas erroneamente podem causar lentidão. Sempre tenha em mente que se uma predefinição foi criada ela está sendo utilizada, e que erros vão prejudicar o visual da wiki.

Página de usuário

Vamos invocar uma página de usuário:Usuário:Je4nPw

Dicas para construir uma boa página:

  • Use wikitexto
  • Use html e css inline, mas apenas o básico.
  • Use predefinições
  • Reserve um espaço para descrever com interlinks as páginas que tem criado e mantido, e também para descrever seus pontos fortes.
  • Use bem o espaço e não carregue imagens demais.
  • E espere novidades com a Gamificação

Página Usuário:Discussão

Esta é a página onde você será informado sobre alterações importantes em páginas que você criou ou deu manutenção. Os Administradores e Burocratas desta wiki tem acesso a uma ferramenta de curadoria onde podemos aprovar ou solicitar reversão de alguns detalhes. Esta também é uma boa página para discutir coisas referentes a colaboração em algum manual.

Exemplo de como interagir na página de discussão. Estou abrindo uma discussão.
--Je4nPw (discussão) 16h01min de 23 de setembro de 2018 (-03)

Eu estou comentando esta discussão
--Je4nPw (discussão) 16h01min de 23 de setembro de 2018 (-03)
Eu voltei a comentar esta discussão
--Je4nPw (discussão) 16h01min de 23 de setembro de 2018 (-03)
Discussão Encerrada.
--Je4nPw (discussão) 16h01min de 23 de setembro de 2018 (-03)

Como ajudar na IXCwiki

A IXCwiki pode se tornar um organismo assim como é a proposta da Wikipedia original.
Antes de levantar esta versão da wiki e investir tempo nela, entrei na wikipedia em português e pesquisei como é o ecossistema de usuários dela, e entendi que a colaboratividade e a conquista individual são duas coisas muito fortes entre eles.
Existem diversas categorizações wiki que podem ser aplicadas, que são:

  1. Cargos
  2. Papéis desempenhados
  3. Conquistas individuais
  4. Conquistas em equipe
  5. Preferências e conquistas pessoais

1 - Cargos administrativos

Atualmente existem na IXCwiki 3 cargos:

  • Burocratas - que dão manutenção a Wiki e curam artigos (é uma conquista lendária);
  • Administradores - que curam artigos (é uma conquista difícil);
  • Usuários - que criam artigos.

2 - Papéis sociais

Estes papéis, após bom desempenho se tornam conquistas:

  • Corretores - corrigem textos e formatações;
  • Categorizadores - inserem categorias nas páginas;
  • Eliminadores - deletam páginas indevidas;
  • Reversores - revertem páginas indevidamente alteradas
  • Curadores - Fazem os todos os papéis anteriores, são Administradores e tem acesso a ferramenta de Curadoria.

3 - Conquistas individuais

Estas conquistas são recompensadas com badges como esta:

1 100+

Estas conquistas podem ser:

  • Quantidades de artigos criados;
  • Um bom artigo ou excelente contribuição
  • Quantidade de edições
  • Um novo wiki cargo;
  • Um novo wiki papel.

4 - Conquistas em equipe

Estas conquistas seguem a mesma idéia das conquistas individuais.

5 - Preferências e conquistas pessoais

Podemos também ganhar badges e ser reconhecidos no ecossistema IXCwiki através de nossas preferências e conquistas pessoais.

Ideia.png Para isso volto a ressaltar a
importância da sua página de usuário.



Na página de usuário é onde podemos "ostentar" nossas conquistas e isso é muito bom e saudável do ponto de vista de um possível cliente que está buscando seriedade no serviço contratado, e ainda restaura um pouco aquela antiga imagem friendly support que existia a 2-3 anos atrás e era bem atrativo ao consumidor final. Todas as conquistas cabem aqui (formatura, aniversário, wikianiversário, mestrado, novo cargo na empresa, etc.).

Conclusão

Creio que com as dicas e meios aprendidos aqui nesta wiki, podemos aplicar métodos cada vez mais aprimorados de documentação dos sistemas que fornecemos, diminuindo a necessidade de suporte, tornando o suporte básico muito mais ágil, permitindo uma curva muito rápida de inclusão de novos colaboradores e novos clientes às ferramentas disponíveis, entre outras vantagens, como ter a wiki mais bonita entre todos os sistemas de gerenciamento de provedor :)

Farm-Fresh user darth vader.png Contribua fazendo sua parte, venha para o lado Like a Boss da IXCwiki!



-
Manual desenvolvido por Je4nPw (discussão) 16h01min de 23 de setembro de 2018 (-03)
-
Voltar para a Página_principal