Slide 1

Slide 1 text

Dokuwiki e a superimportancia da documentação na TI Mario Araujo Xavier @marioaxavier7 linkedin.com/in/marioaxavier7

Slide 2

Slide 2 text

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

Slide 3

Slide 3 text

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

Slide 4

Slide 4 text

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

Slide 5

Slide 5 text

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

Slide 6

Slide 6 text

Quem usa o dokuwiki?

Slide 7

Slide 7 text

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

Slide 8

Slide 8 text

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

Slide 9

Slide 9 text

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

Slide 10

Slide 10 text

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)

Slide 11

Slide 11 text

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

Slide 12

Slide 12 text

Comparativo Dokuwiki, Jira Confluence, MediaWiki, Doxygen, LaTex

Slide 13

Slide 13 text

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

Slide 14

Slide 14 text

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)

Slide 15

Slide 15 text

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

Slide 16

Slide 16 text

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

Slide 17

Slide 17 text

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

Slide 18

Slide 18 text

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

Slide 19

Slide 19 text

Sintaxe exclusiva do dokuwiki

Slide 20

Slide 20 text

Código para criar artigos simples Podemos criar artigos e subartigos usando a sintaxe “=====” ====== Artigo ====== ===== Subartigo ===== ==== Subartigo 2 ===== === Subartigo 3 === == Subartigo 4 ==

Slide 21

Slide 21 text

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:

Slide 22

Slide 22 text

Código para criar links internos e externos Sintaxe para Link interno: [[ Eventos | Clique aqui para ver os eventos do Potilivre ]]

Slide 23

Slide 23 text

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

Slide 24

Slide 24 text

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}}

Slide 25

Slide 25 text

Código para criar repositório de documentos {{wiki:listaRamaisVOIP.pdf}} {{wiki:treinamento.doc}} {{wiki:comunicado.odt}} {{wiki:escalaAlmoco.xls}}

Slide 26

Slide 26 text

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}}

Slide 27

Slide 27 text

Código para criar listas com subniveis

Slide 28

Slide 28 text

Código para criar tabelas

Slide 29

Slide 29 text

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 |

Slide 30

Slide 30 text

Código para emoticons Os caracteres abaixo são convertidos em emoticons:

Slide 31

Slide 31 text

Templates e Plugins para Dokuwiki https://www.dokuwiki.org/template https://www.dokuwiki.org/plugins

Slide 32

Slide 32 text

Dokuwiki e a superimportancia da documentação na TI Mario Araujo Xavier @marioaxavier7 linkedin.com/in/marioaxavier7