Documentando de forma Ágil (usando dokuwiki)

9,845 views

Published on

A apresentação aborda o conceito wiki, documentação ágil e o uso da ferramenta dokuwiki.

Published in: Technology
2 Comments
4 Likes
Statistics
Notes
No Downloads
Views
Total views
9,845
On SlideShare
0
From Embeds
0
Number of Embeds
343
Actions
Shares
0
Downloads
205
Comments
2
Likes
4
Embeds 0
No embeds

No notes for slide

Documentando de forma Ágil (usando dokuwiki)

  1. 1. WIKI Documentado de forma ágil. José Augusto (Guto) Carvalho gutocarvalho@gmail.com @gutocarvalhoTuesday, April 24, 12
  2. 2. Agenda Entendendo Wiki Sintaxe Estrutura Administração Controles de Acesso 46 Slides - 60 a 80 MinutosTuesday, April 24, 12
  3. 3. Entendendo WikiTuesday, April 24, 12
  4. 4. Wiki: O que significa? Os termos wiki (pronunciado /uíqui/ ou /víqui/) e WikiWiki são utilizados para identificar um tipo específico de coleção de documentos em hipertexto ou o software colaborativo usado para criá-lo. O termo "Wiki wiki" significa "extremamente rápido" no idioma havaiano. Fonte: http://pt.wikipedia.org/wiki/WikiTuesday, April 24, 12
  5. 5. Para o SysAdmin/DevOps qual parte da documentação é a mais importante?Tuesday, April 24, 12
  6. 6. Textos c/ Perfumarias? Formatação complexa? Design refinado? Formato fechado? Isso realmente importa?Tuesday, April 24, 12
  7. 7. Nada disso importa, o que importa é o conteúdo.Tuesday, April 24, 12
  8. 8. Necessidades do Sysadmin encontrar a informação de forma simples e rápida entender a informação para que ela lhe seja útil ter condições de modificar a informação com objetivo de complementar, atualizar ou corrigir. editar a informação de forma simples e rápidaTuesday, April 24, 12
  9. 9. Wiki: Características Acesso através de qualquer navegador/OS Formatação do texto em linguagem MarkDown Edição coletiva/colaborativa (equipe) Rastreamento de mudanças (versionamento) Foco no conteúdo (editor sem distrações) Portabilidade do conteúdo (texto puro)Tuesday, April 24, 12
  10. 10. Wiki: Projetos conhecidos MediaWiki (site da wikipedia) Dokuwiki (site de documentação zabbix) MoinMoin (site de documentação projeto apache)Tuesday, April 24, 12
  11. 11. Wiki: Listagem de projetos No site wikimatrix.org você irá conhecer diversas ferramentas wiki, neste site você terá condições de avaliar os recursos e as principais diferenças entre estes sistemas. O site concentra informações referentes a grande maioria dos sistemas wiki open-source conhecidos hoje.Tuesday, April 24, 12
  12. 12. Nossa escolha: DokuwikiTuesday, April 24, 12
  13. 13. Tuesday, April 24, 12
  14. 14. Dokuwiki: Características 1 Aplicação escrita em PHP Não usa banco de dados Velocidade no uso (por não usar banco de dados) Sintaxe de formatação simples (markdown) Suporte a plugins PHP (muitos plugins disponíveis) Suporte a categorização por namespacesTuesday, April 24, 12
  15. 15. Dokuwiki: Características 2 Suporte a links interwikis (wikipedia/dokuwiki) Upload de imagens e uso de referências externas Buscas ‘FullText Search’ com índices Interface Agradável com recursos Ajax Cache de Páginas Suporte a autenticação Local, LDAP, AD, MySQL e PostgreSQLTuesday, April 24, 12
  16. 16. Dokuwiki: Características 3 Suporte a mais de 50 idiomas Código Fonte Aberto Processo de desenvolvimento bem documentado Syndication (RSS/ATOM) das mudanças recentes Outros ... (http://www.dokuwiki.org/features)Tuesday, April 24, 12
  17. 17. Dokuwiki: Diferencial O grande diferencial deste projeto é o fato de [não] utilizar base de dados relacional, tudo é salvo em arquivos no File System.Tuesday, April 24, 12
  18. 18. Dokuwiki: Diferencial O fato de não usar banco de dados, proporciona grande velocidade nas rotinas de criação, edição e leitura das páginas wiki, afinal, os dados são consumidos diretamente do filesystem, a aplicação faz a leitura de arquivos (.txt) em formato ASCII, algo simples, rápido, eficiente e universal.Tuesday, April 24, 12
  19. 19. Dokuwiki: Diferencial Backup simplificado, basta compactar o diretório do dokuwiki para termos todos os dados salvos. Além disto, cada página é um arquivo de texto (.txt) simples, ou seja, nem precisamos ter um servidor de aplicação instalado para ler os dados, qualquer editor de texto puro consegue ler os dados.Tuesday, April 24, 12
  20. 20. SintaxeTuesday, April 24, 12
  21. 21. Linaguagem Markdown MarkDown é uma linguagem de marcação simples, onde você declara a formatação desejada através de símbolos, estes símbolos orientam a conversão do ‘texto puro’ para uma outra linguagem que normalmente é ((x)html). Referências: http://pt.wikiped ia.org/wiki/MarkdownTuesday, April 24, 12
  22. 22. ====== objetivo ======= descreva de forma objetiva, de preferência em uma linha o objetivo dessa wiki para agilizar o entendimento, exemplo: * descrever a instalação de ferramente XPTO no CentOS. ====== descrição ======= Nem sempre a descrição, mas dependendo do manual é bom investir algumas linhas contextualizando a necessidade, exemplo: * a instalacao da ferramenta XPTO foi uma demanda motivada pelo problema XPTO e após análise resolvemos abordar essa solução. ====== procedimento ======= ===== requisitos ===== pacotes/dependencias ===== instalação ===== instalando pacotes, tarballs, permissoes ===== configuração ===== configuracoes em arquivos, servicos, sub-sistemas e no própio aplicativo instalado. ===== operação ===== acesso ao aplicativo e como usar ====== referências ======= sites/links que lhe ajudaram a escrever esse documento, exemplo: * site 1 * site 2 * site 3Tuesday, April 24, 12
  23. 23. Tuesday, April 24, 12
  24. 24. Mão na Massa entendendo na prática como criar e editar wikipagesTuesday, April 24, 12
  25. 25. Acessando wiki Para acesse a wiki entre em http://wiki.dominio.local Clique em Entrar Utilize seu usuário Clique Dokuwiki (no topo superior direito) Clique em PlaygroundTuesday, April 24, 12
  26. 26. [[area:nome|descrição]] [[playground:teste do guto|Página teste do Guto]] criando páginaTuesday, April 24, 12
  27. 27. //Itálico// __sublinhado__ **negrito** <del> tachado <del> Formatação SimplesTuesday, April 24, 12
  28. 28. Lista não Lista ordenada ordenada - Alfredo * Alface - Bernardo * Tomate - Camila * Cebola - Daniel * Alho - Euclides dois espaços no inicio da linha antes do simbolo ListasTuesday, April 24, 12
  29. 29. http://www.google.com www.google.com [[http://www.google.com | Acesse o google]] [[wp > wiki]] [[infraestrutura:modelo de projeto|Visualize o modelo de Projeto]] linksTuesday, April 24, 12
  30. 30. {{area:nome.png | descricao caption}} {{url | descricao caption}} {{wiki:fotoguto.png | Foto do Gutocarvalho}} {{infraestrutura:racks.png | Foto dos Racks do CPD}} {{www.site.com/logo.png | Logo do Detran}} ImagensTuesday, April 24, 12
  31. 31. ^Nome^Telefone^ | Jose Augusto | 5555-5555 | | Fernando | 5555-5555 | TabelasTuesday, April 24, 12
  32. 32. Execute o comando (dois espaços) comando 1 comando 2 <code> conteúdo longo </code> Destacando TextoTuesday, April 24, 12
  33. 33. <file php arquivo.php> <?php echo "hello world!"; ?> </file> Conteúdo ArquivoTuesday, April 24, 12
  34. 34. EstruturaTuesday, April 24, 12
  35. 35. Tuesday, April 24, 12
  36. 36. Tuesday, April 24, 12
  37. 37. AdministraçãoTuesday, April 24, 12
  38. 38. Área administrativaTuesday, April 24, 12
  39. 39. Gerenciamento de PluginsTuesday, April 24, 12
  40. 40. Gerenciamento de UsuáriosTuesday, April 24, 12
  41. 41. Controles de AcessoTuesday, April 24, 12
  42. 42. Permissões Exemplo 1Tuesday, April 24, 12
  43. 43. Permissões Exemplo 2Tuesday, April 24, 12
  44. 44. Protegendo Páginas Wiki [[área:nome|descrição]] [[infraestrutura:nome|descrição]] [[infraestrutura:procedimentos:nome|descrição]] [[infraestrutura:ambiente:nome|descrição]] [[infraestrutura:processos:nome|descrição]] [[desenvolvimento:nome|descrição]] [[desenvolvimento:testes::nome|descrição]] [[desenvolvimento:homologação::nome|descrição]] [[playground:nome|descrição]]Tuesday, April 24, 12
  45. 45. Perguntas? (5 min) José Augusto (Guto) Carvalho gutocarvalho@gmail.com http://gutocarvalho.net @gutocarvalhoTuesday, April 24, 12
  46. 46. Obrigado José Augusto (Guto) Carvalho gutocarvalho@gmail.com http://gutocarvalho.net @gutocarvalhoTuesday, April 24, 12

×