Dokuwiki e a superimportancia da documentacao na TI

1) O que é o dokuwiki?
2)Quem usa o Dokuwiki?
3)Porque a documentação é tão importante?
4)Documentação de servidores e infraestrutura
5)Comparativo Dokuwiki, Jira Confluence, MediaWiki, Doxygen
6)Caso de sucesso Dokuwiki: Industria de camarão Camanor Brasil
7)Como subir dokuwiki no debian?
8)Sintaxe exclusiva do dokuwiki
9)Código para criar artigo simples

Transcript

1. Dokuwiki e a superimportancia da documentação na TI Mario Araujo Xavier @marioaxavier7 linkedin.com/in/marioaxavier7
2. Quem sou eu 1) Natalense morando em Florianópolis 2) Carreira em infraestrutura Microsoft: Windows Server, Hyper-V e Azure 3) Tenho 3 certificações oficiais Microsoft 4) Apaixonado por Linux, KDE e Software Livre 5) Membro da equipe de Marketing do KDE 6) Coordenador do Software Freedom Day Porto Alegre – Faculdade Alcides Maya 7) Goleiro nos finais de semana #VaiCorinthians
3. Roteiro 1) O que é o dokuwiki? 2)Quem usa o Dokuwiki? 3)Porque a documentação é tão importante? 4)Documentação de servidores e infraestrutura 5)Comparativo Dokuwiki, Jira Confluence, MediaWiki, Doxygen 6)Caso de sucesso Dokuwiki: Industria de camarão Camanor Brasil 7)Como subir dokuwiki no debian? 8)Sintaxe exclusiva do dokuwiki 9)Código para criar artigo simples
4. Roteiro 10) Código para criar links internos e externos 11) Código para criar links \\servidor\compartilhamento 12) Código para criar links para anexar imagens, áudio e vídeo com parametrizações 13) Código para criar repositório de documentos 14) Código para criar repositório de software 15) Código para criar listas com subníveis e tabelas 16)Código para Emoticons XD 17)Templates e Plugins
5. O que é o dokuwiki? • Software livre para documentação escrito em PHP. • Podemos criar artigos e subartigos por hierarquia ou páginas separadas • Podemos definir permissões de usuário e grupos • Podemos criar documentação em texto, foto, vídeo, links e PDF embutido • Cada pagina é escrita em um arquivo .txt, que contem a sintaxe dokuwiki
6. Quem usa o dokuwiki?
7. Porque a documentação é tão importante? 1) Documentar facilita o trabalho do outro, permite trabalho colaborativo 2)Documentar agiliza o entendimento e troubleshooting: não é preciso reinventar a roda 3)Documentar diminui a curva de aprendizagem em infraestruturas de rede e codigos enormes 4)Documentar orienta a expansão da infraestrutura, as principais necessidades e o que precisa melhorar
8. Porque a documentação é tão importante? 5)Documentar faz processos evoluirem, principalmente com diagramas/BPM/UML 6)Documentar ajuda novos colaboradores da TI 7)Documentar aumenta a proatividade, continuidade do trabalho e manutenção preventiva, principalmente com checklists Cenário 1: documentação no problema em rede cascateada dentro da industria Cenário 2: documentação na ausência do programador PHP
9. Documentação de servidores Para servidores é recomendável documentar: 1) Hardware: processador, memoria, disco, RAID, firmware, fabricante, garantia e upgrade/expansão possíveis 2) Rede: escopo de IP, Gateways, subnets, mascaras, DNS, DHCP, VLAN e redundancias 3) Software: SO, Dominio, DNS, DHCP, File Server, Web Server, Homologação, Backup e Disaster Recovery, Cluster, Licenciamento, ERP, CRM, Intranet
10. Documentação de infraestrutura Para infraestrutura é recomendável documentar: 1) Rack, pontos lógicos, switches, roteadores, VPN, Firewall, Links e Provedores de internet 2) Contato/CNPJ/Razão Social dos fornecedores, contratos e SLA 3) Rotinas e procedimentos: backup, restore, manutenção preventiva e corretiva, testes e homologações, inclusão de permissões de acesso(usuarios, grupos, contas etc)
11. Comparativo Dokuwiki, Jira Confluence, MediaWiki, Doxygen, LaTex • Sistema de documentação associado ao Jira Software, Jira Service Desk e outros produtos Atlassian • Organizado por categorias, e com editor de texto avançado • Podemos vincular soluções de chamados do Jira ao procedimento documentado no Confluence • • Cenário: Documentação exigida no SLA em usina hidreletrica
12. Comparativo Dokuwiki, Jira Confluence, MediaWiki, Doxygen, LaTex
13. Comparativo Dokuwiki, Jira Confluence, MediaWiki, Doxygen • Sistema web escrito em PHP e origem do Wikipedia, WikiBooks, etc • Usado para criar o WikiBB: hospeda relatório anual do Banco do Brasil para o Banco Central e investidores
14. Comparativo Dokuwiki, Jira Confluence, MediaWiki, Doxygen • Sistema que gera documentação padronizada em vários formatos, evitando trabalho braçal • Gera documentação em HTML, LaTex, RTF, Postscript, PDF com gra U ficos e diagramas em hierarquias/dependencias • Usado pela Adobe, Autodesk, iTunes, KDE, Asterisk, Red Hat Package Manager(RPM)
15. If you are looking for documentation about KDE software or how to use Plasma, please refer to our riserbase ’a'ebsire. Otner KDE Products • Other KDE Scft'a'6 r°. • Extra CMa ke Modules Deprecated Products • KDE C k4akiZ k4Dd u • Olcl KD E Versions Documentation KDE Products KDE Human Interface Guidelines The KDE Frameworks Providing everything from simple utili classes to integrated solutions for common requirements of desktop applications Maintai ner: The KDE Community Platforms: Android (partial) | FreeBSD (partial) | Linux | macOS (partial) | Windows (partial) KDE PIM KDE PIM provides set of libraries and application to access and manage personal information like emails, contacts, events, etc. Maintai ner: The KDE Community Platform: Linux Baloo Widgets Widgets for Baloo Maintai ner: Thc KDE Community Platforms: FreeBSD | Linux Windows
16. Caso de sucesso Dokuwiki: Industria de camarão Camanor • • • • • A TI da indústria ainda não tinha documentação geral de infra e dev Existiam alguns artigos em pastas e desatualizados Organizamos no dokuwiki por filial, por categoria, com diagramas de rede, processos, tabela de IP e servidores, virtualização, redundancia e backup. Alem da documentação de TI, adicionamos contratos, CNPJs das filiais, IP CFTV, ramais VOIP, etc Na hora que a TI vira um caos, a documentação ajuda muito a solucionar rapidamente
17. Como subir dokuwiki no debian? • É preciso baixar, descompactar o pacote e subir para seu localhost/servidor/nuvem • Abra o arquivo install.php, siga as instruções e seja feliz XD
18. Sintaxe exclusiva do dokuwiki • Para adicionar qualquer artigo, PDF, foto, video, tabela, plugin, é preciso seguir a sintaxe • Dokuwiki tem sua propria sintaxe, que facilita os ajustes e permite criar documentação muito exclusiva, modelando de acordo com a necessidade
19. Sintaxe exclusiva do dokuwiki
20. Código para criar artigos simples Podemos criar artigos e subartigos usando a sintaxe “=====” ====== Artigo ====== ===== Subartigo ===== ==== Subartigo 2 ===== === Subartigo 3 === == Subartigo 4 ==
21. Código para criar links internos e externos Sintaxe para Link externo: [[http://www.potilivre.org| Clique aqui para acessar o Potilivre]] Sintaxe para email: <contato@potilivre.org>
22. Código para criar links internos e externos Sintaxe para Link interno: [[ Eventos | Clique aqui para ver os eventos do Potilivre ]]
23. Código para criar links SMB \\servidor\compartilhamento Sintaxe funciona tanto para nome (\\servidor) e IP ( \\192.168.x.x), redirecionando e abrindo o compartilhamento
24. Código para criar links para anexar imagens, áudio e vídeo Depois de subir os arquivos para o dokuwiki, usamos a sintaxe: {{wiki:grafico.png}} {{wiki:gravacao.mp3}} {{wiki:tutorial.avi}}
25. Código para criar repositório de documentos {{wiki:listaRamaisVOIP.pdf}} {{wiki:treinamento.doc}} {{wiki:comunicado.odt}} {{wiki:escalaAlmoco.xls}}
26. Código para criar repositório de software {{wiki:LimparSpooler.bat}} {{wiki:Firefox.msi}} {{https://www.7-zip.org/a/7z1900.exe}} {{https://espejito.fder.edu.uy/videolan/vlc/3.0.16/ win32/vlc-3.0.16-win32.exe}}
27. Código para criar listas com subniveis
28. Código para criar tabelas
29. Código para criar tabelas Vamos criar uma tabela de ips dos servidores: ^ FQDN ^ IP ^ Serviço ^ | canada.empresa.local | 192.168.1.100 | DNS | | inglaterra.empresa.local | 192.168.1.150 | Tomcat | | irlanda.empresa.local | 192.168.1.170 | NGINX | | espanha.empresa.local | 192.168.4.200 | PostgreSQL | | china.empresa.local | 192.168.3.201 | Node.JS |
30. Código para emoticons Os caracteres abaixo são convertidos em emoticons:
31. Templates e Plugins para Dokuwiki https://www.dokuwiki.org/template https://www.dokuwiki.org/plugins
32. Dokuwiki e a superimportancia da documentação na TI Mario Araujo Xavier @marioaxavier7 linkedin.com/in/marioaxavier7