SlideShare uma empresa Scribd logo
WIKI
                        Documentado de forma ágil.



                                         José Augusto (Guto) Carvalho
                                              gutocarvalho@gmail.com
                                                       @gutocarvalho
Tuesday, April 24, 12
Agenda

                        Entendendo Wiki
                        Sintaxe
                        Estrutura
                        Administração
                        Controles de Acesso
                                              46 Slides - 60 a 80 Minutos
Tuesday, April 24, 12
Entendendo Wiki


Tuesday, April 24, 12
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/Wiki


Tuesday, April 24, 12
Para o SysAdmin/DevOps qual parte
                        da documentação é a mais importante?




Tuesday, April 24, 12
Textos c/ Perfumarias?
                        Formatação complexa?
                           Design refinado?
                          Formato fechado?

                        Isso realmente importa?

Tuesday, April 24, 12
Nada disso importa, o
                          que importa é o
                           conteúdo.

Tuesday, April 24, 12
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ápida


Tuesday, April 24, 12
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
Wiki: Projetos conhecidos

                        MediaWiki (site da wikipedia)
                        Dokuwiki (site de documentação zabbix)
                        MoinMoin (site de documentação projeto apache)


Tuesday, April 24, 12
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
Nossa escolha: Dokuwiki
Tuesday, April 24, 12
Tuesday, April 24, 12
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 namespaces
Tuesday, April 24, 12
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 PostgreSQL
Tuesday, April 24, 12
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
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
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
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
Sintaxe


Tuesday, April 24, 12
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/Markdown




Tuesday, April 24, 12
====== 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 3

Tuesday, April 24, 12
Tuesday, April 24, 12
Mão na Massa
                        entendendo na prática como criar e editar wikipages




Tuesday, April 24, 12
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 Playground

Tuesday, April 24, 12
[[area:nome|descrição]]

                   [[playground:teste do guto|Página teste do Guto]]




                           criando página
Tuesday, April 24, 12
//Itálico//

                             __sublinhado__

                               **negrito**

                           <del> tachado <del>



                        Formatação Simples
Tuesday, April 24, 12
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




                                                        Listas
Tuesday, April 24, 12
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]]




                                        links
Tuesday, April 24, 12
{{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}}



                                  Imagens
Tuesday, April 24, 12
^Nome^Telefone^
                        | Jose Augusto    | 5555-5555 |
                        | Fernando         | 5555-5555 |




                               Tabelas
Tuesday, April 24, 12
Execute o comando (dois espaços)
           comando 1
           comando 2


          <code>
          conteúdo longo
          </code>


                        Destacando Texto
Tuesday, April 24, 12
<file php arquivo.php>

                        <?php echo "hello world!"; ?>

                        </file>



                        Conteúdo Arquivo
Tuesday, April 24, 12
Estrutura


Tuesday, April 24, 12
Tuesday, April 24, 12
Tuesday, April 24, 12
Administração


Tuesday, April 24, 12
Área administrativa




Tuesday, April 24, 12
Gerenciamento de Plugins




Tuesday, April 24, 12
Gerenciamento de Usuários




Tuesday, April 24, 12
Controles de Acesso


Tuesday, April 24, 12
Permissões Exemplo 1




Tuesday, April 24, 12
Permissões Exemplo 2




Tuesday, April 24, 12
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
Perguntas? (5 min)
                                   José Augusto (Guto) Carvalho
                                        gutocarvalho@gmail.com
                                         http://gutocarvalho.net
                                                 @gutocarvalho

Tuesday, April 24, 12
Obrigado
                              José Augusto (Guto) Carvalho
                                   gutocarvalho@gmail.com
                                    http://gutocarvalho.net
                                            @gutocarvalho

Tuesday, April 24, 12

Mais conteúdo relacionado

Mais procurados

Microsoft 365 を使い、よりよい業務環境の在り方と仕事への向き合い方を考えよう
Microsoft 365 を使い、よりよい業務環境の在り方と仕事への向き合い方を考えようMicrosoft 365 を使い、よりよい業務環境の在り方と仕事への向き合い方を考えよう
Microsoft 365 を使い、よりよい業務環境の在り方と仕事への向き合い方を考えよう
Ai Hirano
 
Part 4: Power Platform 概説 (製造リファレンス・アーキテクチャ勉強会)
Part 4: Power Platform 概説 (製造リファレンス・アーキテクチャ勉強会)Part 4: Power Platform 概説 (製造リファレンス・アーキテクチャ勉強会)
Part 4: Power Platform 概説 (製造リファレンス・アーキテクチャ勉強会)
Takeshi Fukuhara
 
SharePoint Online へのアクセスを制限しよう
SharePoint Online へのアクセスを制限しようSharePoint Online へのアクセスを制限しよう
SharePoint Online へのアクセスを制限しよう
Hirofumi Ota
 
Migrating 3000 users and 1100 applications from Lotus Notes to Office 365
Migrating 3000 users and 1100 applications from Lotus Notes to Office 365Migrating 3000 users and 1100 applications from Lotus Notes to Office 365
Migrating 3000 users and 1100 applications from Lotus Notes to Office 365
Arno Flapper
 
Cots - commercial off the shelf
Cots - commercial off the shelfCots - commercial off the shelf
Cots - commercial off the shelf
Marcos Antonio Vieira da Silva
 
Microsoft Viva Insights Overview 概要.pdf
Microsoft Viva Insights Overview 概要.pdfMicrosoft Viva Insights Overview 概要.pdf
Microsoft Viva Insights Overview 概要.pdf
ayako uruno
 
ARC-009_RDB 技術者のための NoSQL ガイド
ARC-009_RDB 技術者のための NoSQL ガイドARC-009_RDB 技術者のための NoSQL ガイド
ARC-009_RDB 技術者のための NoSQL ガイド
decode2016
 
GoodBye AD FS - Azure Active Directory Only の認証方式へ切り替えよう!
GoodBye AD FS - Azure Active Directory Only の認証方式へ切り替えよう!GoodBye AD FS - Azure Active Directory Only の認証方式へ切り替えよう!
GoodBye AD FS - Azure Active Directory Only の認証方式へ切り替えよう!
Yusuke Kodama
 
Microsoft PowerApps and Flow
Microsoft PowerApps and FlowMicrosoft PowerApps and Flow
Microsoft PowerApps and Flow
Steve Knutson
 
SharePoint Hub Sites について学ぶ
SharePoint Hub Sites について学ぶ SharePoint Hub Sites について学ぶ
SharePoint Hub Sites について学ぶ
Ai Hirano
 
Exchange online切替時の検討事項
Exchange online切替時の検討事項Exchange online切替時の検討事項
Exchange online切替時の検討事項
Shu Yamada
 
メタデータのファイルの管理
メタデータのファイルの管理メタデータのファイルの管理
メタデータのファイルの管理Sylvain Gantois
 
MCAS High Level Architecture May 2021
MCAS High Level Architecture May 2021MCAS High Level Architecture May 2021
MCAS High Level Architecture May 2021
Matt Soseman
 
AZ-104T00A-ENU-PowerPoint_00.pptx
AZ-104T00A-ENU-PowerPoint_00.pptxAZ-104T00A-ENU-PowerPoint_00.pptx
AZ-104T00A-ENU-PowerPoint_00.pptx
AliChallioui
 
[20171019 三木会] データベース・マイグレーションについて by 株式会社シー・エス・イー 藤井 元雄 氏
[20171019 三木会] データベース・マイグレーションについて by 株式会社シー・エス・イー 藤井 元雄 氏[20171019 三木会] データベース・マイグレーションについて by 株式会社シー・エス・イー 藤井 元雄 氏
[20171019 三木会] データベース・マイグレーションについて by 株式会社シー・エス・イー 藤井 元雄 氏
Insight Technology, Inc.
 
Dynamics 365 for Finance and Operations - Power BI
Dynamics 365 for Finance and Operations - Power BIDynamics 365 for Finance and Operations - Power BI
Dynamics 365 for Finance and Operations - Power BI
Juan Fabian
 
ぶっちゃけAIPスキャナってどうよ?~AIPスキャナ検証録~
ぶっちゃけAIPスキャナってどうよ?~AIPスキャナ検証録~ぶっちゃけAIPスキャナってどうよ?~AIPスキャナ検証録~
ぶっちゃけAIPスキャナってどうよ?~AIPスキャナ検証録~
Akito Katsumata
 
Sistema de gerenciamento de banco de dados
Sistema de gerenciamento de banco de dadosSistema de gerenciamento de banco de dados
Sistema de gerenciamento de banco de dados
Juh Souza
 
Power platform Bootcamp Bulgaria 2021 - Power Platform Security
Power platform Bootcamp Bulgaria 2021 - Power Platform SecurityPower platform Bootcamp Bulgaria 2021 - Power Platform Security
Power platform Bootcamp Bulgaria 2021 - Power Platform Security
Dipti Chhatrapati
 
Autonomous を支える技術、Oracle Database 18c デモンストレーション
Autonomous を支える技術、Oracle Database 18c デモンストレーションAutonomous を支える技術、Oracle Database 18c デモンストレーション
Autonomous を支える技術、Oracle Database 18c デモンストレーション
オラクルエンジニア通信
 

Mais procurados (20)

Microsoft 365 を使い、よりよい業務環境の在り方と仕事への向き合い方を考えよう
Microsoft 365 を使い、よりよい業務環境の在り方と仕事への向き合い方を考えようMicrosoft 365 を使い、よりよい業務環境の在り方と仕事への向き合い方を考えよう
Microsoft 365 を使い、よりよい業務環境の在り方と仕事への向き合い方を考えよう
 
Part 4: Power Platform 概説 (製造リファレンス・アーキテクチャ勉強会)
Part 4: Power Platform 概説 (製造リファレンス・アーキテクチャ勉強会)Part 4: Power Platform 概説 (製造リファレンス・アーキテクチャ勉強会)
Part 4: Power Platform 概説 (製造リファレンス・アーキテクチャ勉強会)
 
SharePoint Online へのアクセスを制限しよう
SharePoint Online へのアクセスを制限しようSharePoint Online へのアクセスを制限しよう
SharePoint Online へのアクセスを制限しよう
 
Migrating 3000 users and 1100 applications from Lotus Notes to Office 365
Migrating 3000 users and 1100 applications from Lotus Notes to Office 365Migrating 3000 users and 1100 applications from Lotus Notes to Office 365
Migrating 3000 users and 1100 applications from Lotus Notes to Office 365
 
Cots - commercial off the shelf
Cots - commercial off the shelfCots - commercial off the shelf
Cots - commercial off the shelf
 
Microsoft Viva Insights Overview 概要.pdf
Microsoft Viva Insights Overview 概要.pdfMicrosoft Viva Insights Overview 概要.pdf
Microsoft Viva Insights Overview 概要.pdf
 
ARC-009_RDB 技術者のための NoSQL ガイド
ARC-009_RDB 技術者のための NoSQL ガイドARC-009_RDB 技術者のための NoSQL ガイド
ARC-009_RDB 技術者のための NoSQL ガイド
 
GoodBye AD FS - Azure Active Directory Only の認証方式へ切り替えよう!
GoodBye AD FS - Azure Active Directory Only の認証方式へ切り替えよう!GoodBye AD FS - Azure Active Directory Only の認証方式へ切り替えよう!
GoodBye AD FS - Azure Active Directory Only の認証方式へ切り替えよう!
 
Microsoft PowerApps and Flow
Microsoft PowerApps and FlowMicrosoft PowerApps and Flow
Microsoft PowerApps and Flow
 
SharePoint Hub Sites について学ぶ
SharePoint Hub Sites について学ぶ SharePoint Hub Sites について学ぶ
SharePoint Hub Sites について学ぶ
 
Exchange online切替時の検討事項
Exchange online切替時の検討事項Exchange online切替時の検討事項
Exchange online切替時の検討事項
 
メタデータのファイルの管理
メタデータのファイルの管理メタデータのファイルの管理
メタデータのファイルの管理
 
MCAS High Level Architecture May 2021
MCAS High Level Architecture May 2021MCAS High Level Architecture May 2021
MCAS High Level Architecture May 2021
 
AZ-104T00A-ENU-PowerPoint_00.pptx
AZ-104T00A-ENU-PowerPoint_00.pptxAZ-104T00A-ENU-PowerPoint_00.pptx
AZ-104T00A-ENU-PowerPoint_00.pptx
 
[20171019 三木会] データベース・マイグレーションについて by 株式会社シー・エス・イー 藤井 元雄 氏
[20171019 三木会] データベース・マイグレーションについて by 株式会社シー・エス・イー 藤井 元雄 氏[20171019 三木会] データベース・マイグレーションについて by 株式会社シー・エス・イー 藤井 元雄 氏
[20171019 三木会] データベース・マイグレーションについて by 株式会社シー・エス・イー 藤井 元雄 氏
 
Dynamics 365 for Finance and Operations - Power BI
Dynamics 365 for Finance and Operations - Power BIDynamics 365 for Finance and Operations - Power BI
Dynamics 365 for Finance and Operations - Power BI
 
ぶっちゃけAIPスキャナってどうよ?~AIPスキャナ検証録~
ぶっちゃけAIPスキャナってどうよ?~AIPスキャナ検証録~ぶっちゃけAIPスキャナってどうよ?~AIPスキャナ検証録~
ぶっちゃけAIPスキャナってどうよ?~AIPスキャナ検証録~
 
Sistema de gerenciamento de banco de dados
Sistema de gerenciamento de banco de dadosSistema de gerenciamento de banco de dados
Sistema de gerenciamento de banco de dados
 
Power platform Bootcamp Bulgaria 2021 - Power Platform Security
Power platform Bootcamp Bulgaria 2021 - Power Platform SecurityPower platform Bootcamp Bulgaria 2021 - Power Platform Security
Power platform Bootcamp Bulgaria 2021 - Power Platform Security
 
Autonomous を支える技術、Oracle Database 18c デモンストレーション
Autonomous を支える技術、Oracle Database 18c デモンストレーションAutonomous を支える技術、Oracle Database 18c デモンストレーション
Autonomous を支える技術、Oracle Database 18c デモンストレーション
 

Destaque

Wiki como ferramenta de colaboração em empresas familiares – estudo de caso
Wiki como ferramenta de colaboração em empresas familiares – estudo de casoWiki como ferramenta de colaboração em empresas familiares – estudo de caso
Wiki como ferramenta de colaboração em empresas familiares – estudo de caso
Francisco Aparecido da Silva
 
Bypass de token csrf na pratica secure brasil
Bypass de token csrf na pratica secure brasilBypass de token csrf na pratica secure brasil
Bypass de token csrf na pratica secure brasil
William Costa
 
Apresentação exploit
Apresentação exploitApresentação exploit
Apresentação exploit
Denis Vieira
 
Carlos Veiga - Aula05 - Cabeamento Estruturado - (parte02)
Carlos Veiga - Aula05 - Cabeamento Estruturado - (parte02)Carlos Veiga - Aula05 - Cabeamento Estruturado - (parte02)
Carlos Veiga - Aula05 - Cabeamento Estruturado - (parte02)
Heber Souza
 
Monitoramento da rede de A a ZABBIX - Daniel Bauermann
Monitoramento da rede de A a ZABBIX - Daniel BauermannMonitoramento da rede de A a ZABBIX - Daniel Bauermann
Monitoramento da rede de A a ZABBIX - Daniel Bauermann
Tchelinux
 
Trabalho de fibra óptica
Trabalho de fibra óptica Trabalho de fibra óptica
Trabalho de fibra óptica
Cantinho do Saber
 
Documentos de software
Documentos de softwareDocumentos de software
Documentos de software
Júlio Fernandes
 
FTTH para ISPs
FTTH para ISPsFTTH para ISPs
FTTH para ISPs
Luiz Gustavo Schmoekel
 
Lançamento do livro "De A a Zabbix" no IFPB
Lançamento do livro "De A a Zabbix" no IFPBLançamento do livro "De A a Zabbix" no IFPB
Lançamento do livro "De A a Zabbix" no IFPB
Aécio Pires
 

Destaque (9)

Wiki como ferramenta de colaboração em empresas familiares – estudo de caso
Wiki como ferramenta de colaboração em empresas familiares – estudo de casoWiki como ferramenta de colaboração em empresas familiares – estudo de caso
Wiki como ferramenta de colaboração em empresas familiares – estudo de caso
 
Bypass de token csrf na pratica secure brasil
Bypass de token csrf na pratica secure brasilBypass de token csrf na pratica secure brasil
Bypass de token csrf na pratica secure brasil
 
Apresentação exploit
Apresentação exploitApresentação exploit
Apresentação exploit
 
Carlos Veiga - Aula05 - Cabeamento Estruturado - (parte02)
Carlos Veiga - Aula05 - Cabeamento Estruturado - (parte02)Carlos Veiga - Aula05 - Cabeamento Estruturado - (parte02)
Carlos Veiga - Aula05 - Cabeamento Estruturado - (parte02)
 
Monitoramento da rede de A a ZABBIX - Daniel Bauermann
Monitoramento da rede de A a ZABBIX - Daniel BauermannMonitoramento da rede de A a ZABBIX - Daniel Bauermann
Monitoramento da rede de A a ZABBIX - Daniel Bauermann
 
Trabalho de fibra óptica
Trabalho de fibra óptica Trabalho de fibra óptica
Trabalho de fibra óptica
 
Documentos de software
Documentos de softwareDocumentos de software
Documentos de software
 
FTTH para ISPs
FTTH para ISPsFTTH para ISPs
FTTH para ISPs
 
Lançamento do livro "De A a Zabbix" no IFPB
Lançamento do livro "De A a Zabbix" no IFPBLançamento do livro "De A a Zabbix" no IFPB
Lançamento do livro "De A a Zabbix" no IFPB
 

Semelhante a Documentando de forma Ágil (usando dokuwiki)

Repositorios
RepositoriosRepositorios
Repositorios
denilsonmello
 
Repositorios
RepositoriosRepositorios
Repositorios
denilsonmello
 
Qualidade de Software: Ferramentas de apoio
Qualidade de Software: Ferramentas de apoioQualidade de Software: Ferramentas de apoio
Qualidade de Software: Ferramentas de apoio
Alex Camargo
 
Plataformas wiki
Plataformas wikiPlataformas wiki
Plataformas wiki
Francisco Nunes
 
Latex2e - guia rápido e básico
Latex2e - guia rápido e básicoLatex2e - guia rápido e básico
Latex2e - guia rápido e básico
Renato Guimarães
 
Criação de uma base de dados para gestão de uma biblioteca
Criação de uma base de dados para gestão de uma bibliotecaCriação de uma base de dados para gestão de uma biblioteca
Criação de uma base de dados para gestão de uma biblioteca
David Canjamba 2D
 
Dokuwiki e a superimportancia da documentacao na TI
Dokuwiki e a superimportancia da documentacao na TIDokuwiki e a superimportancia da documentacao na TI
Dokuwiki e a superimportancia da documentacao na TI
marioaxavier7
 
Software D Space 4 Gerenciamento
Software D Space 4 GerenciamentoSoftware D Space 4 Gerenciamento
Software D Space 4 Gerenciamento
Miguel Angel Mardero Arellano
 
Apresentação sobre Drupal
Apresentação sobre DrupalApresentação sobre Drupal
Apresentação sobre Drupal
Webdrop
 
Apresentação Docker
Apresentação DockerApresentação Docker
Apresentação Docker
André Justi
 
[Engenharia de Software] Marquivos.com
[Engenharia de Software] Marquivos.com[Engenharia de Software] Marquivos.com
[Engenharia de Software] Marquivos.com
Bruno Dadalt Zambiazi
 
Lista de ferramentas na web 2
Lista de ferramentas  na web 2Lista de ferramentas  na web 2
Lista de ferramentas na web 2
peacel
 
Minicurso - Introdução ao LaTeX
Minicurso - Introdução ao LaTeXMinicurso - Introdução ao LaTeX
Minicurso - Introdução ao LaTeX
Rodrigo Smarzaro
 
Wiki
WikiWiki

Semelhante a Documentando de forma Ágil (usando dokuwiki) (14)

Repositorios
RepositoriosRepositorios
Repositorios
 
Repositorios
RepositoriosRepositorios
Repositorios
 
Qualidade de Software: Ferramentas de apoio
Qualidade de Software: Ferramentas de apoioQualidade de Software: Ferramentas de apoio
Qualidade de Software: Ferramentas de apoio
 
Plataformas wiki
Plataformas wikiPlataformas wiki
Plataformas wiki
 
Latex2e - guia rápido e básico
Latex2e - guia rápido e básicoLatex2e - guia rápido e básico
Latex2e - guia rápido e básico
 
Criação de uma base de dados para gestão de uma biblioteca
Criação de uma base de dados para gestão de uma bibliotecaCriação de uma base de dados para gestão de uma biblioteca
Criação de uma base de dados para gestão de uma biblioteca
 
Dokuwiki e a superimportancia da documentacao na TI
Dokuwiki e a superimportancia da documentacao na TIDokuwiki e a superimportancia da documentacao na TI
Dokuwiki e a superimportancia da documentacao na TI
 
Software D Space 4 Gerenciamento
Software D Space 4 GerenciamentoSoftware D Space 4 Gerenciamento
Software D Space 4 Gerenciamento
 
Apresentação sobre Drupal
Apresentação sobre DrupalApresentação sobre Drupal
Apresentação sobre Drupal
 
Apresentação Docker
Apresentação DockerApresentação Docker
Apresentação Docker
 
[Engenharia de Software] Marquivos.com
[Engenharia de Software] Marquivos.com[Engenharia de Software] Marquivos.com
[Engenharia de Software] Marquivos.com
 
Lista de ferramentas na web 2
Lista de ferramentas  na web 2Lista de ferramentas  na web 2
Lista de ferramentas na web 2
 
Minicurso - Introdução ao LaTeX
Minicurso - Introdução ao LaTeXMinicurso - Introdução ao LaTeX
Minicurso - Introdução ao LaTeX
 
Wiki
WikiWiki
Wiki
 

Mais de Jose Augusto Carvalho

Trabalhando com Módulos no Puppet
Trabalhando com Módulos no PuppetTrabalhando com Módulos no Puppet
Trabalhando com Módulos no Puppet
Jose Augusto Carvalho
 
Orquestração com Mcollective
Orquestração com McollectiveOrquestração com Mcollective
Orquestração com Mcollective
Jose Augusto Carvalho
 
Infraestrutura ágil com Puppet - CISL
Infraestrutura ágil com Puppet - CISLInfraestrutura ágil com Puppet - CISL
Infraestrutura ágil com Puppet - CISL
Jose Augusto Carvalho
 
Cultura DevOps - Integração entre infra e devel
Cultura DevOps - Integração entre infra e develCultura DevOps - Integração entre infra e devel
Cultura DevOps - Integração entre infra e devel
Jose Augusto Carvalho
 
Infraestrutura como código com Puppet e Mcollective
Infraestrutura como código com Puppet e McollectiveInfraestrutura como código com Puppet e Mcollective
Infraestrutura como código com Puppet e Mcollective
Jose Augusto Carvalho
 
Cultura DevOps e integração entre infra e devel
Cultura DevOps e integração entre infra e develCultura DevOps e integração entre infra e devel
Cultura DevOps e integração entre infra e devel
Jose Augusto Carvalho
 
Oficina de infraestrutura como código (apresentando o Puppet)
Oficina de infraestrutura como código (apresentando o Puppet)Oficina de infraestrutura como código (apresentando o Puppet)
Oficina de infraestrutura como código (apresentando o Puppet)
Jose Augusto Carvalho
 
Ferramentas para infraestrutura ágil
Ferramentas para infraestrutura ágilFerramentas para infraestrutura ágil
Ferramentas para infraestrutura ágil
Jose Augusto Carvalho
 
Conhecendo o Wordpress
Conhecendo o WordpressConhecendo o Wordpress
Conhecendo o Wordpress
Jose Augusto Carvalho
 
Monitoração avançada com Zabbix 2
Monitoração avançada com Zabbix 2Monitoração avançada com Zabbix 2
Monitoração avançada com Zabbix 2
Jose Augusto Carvalho
 
O que é DevOps afinal?
O que é DevOps afinal?O que é DevOps afinal?
O que é DevOps afinal?
Jose Augusto Carvalho
 
Palestra Puppet Hora Livre
Palestra Puppet Hora LivrePalestra Puppet Hora Livre
Palestra Puppet Hora Livre
Jose Augusto Carvalho
 
Oficina Puppet latinoware
Oficina Puppet latinowareOficina Puppet latinoware
Oficina Puppet latinoware
Jose Augusto Carvalho
 
Puppet webcast 4linux
Puppet webcast 4linuxPuppet webcast 4linux
Puppet webcast 4linux
Jose Augusto Carvalho
 
Oficina Puppet - Aprenda a Gerenciar Configurações
Oficina Puppet - Aprenda a Gerenciar ConfiguraçõesOficina Puppet - Aprenda a Gerenciar Configurações
Oficina Puppet - Aprenda a Gerenciar Configurações
Jose Augusto Carvalho
 
Puppet Cloud IaaS
Puppet Cloud IaaSPuppet Cloud IaaS
Puppet Cloud IaaS
Jose Augusto Carvalho
 
Consegi 2011: Puppet
Consegi 2011: PuppetConsegi 2011: Puppet
Consegi 2011: Puppet
Jose Augusto Carvalho
 
Consegi 2011: Ganeti + Puppet
Consegi 2011: Ganeti + PuppetConsegi 2011: Ganeti + Puppet
Consegi 2011: Ganeti + Puppet
Jose Augusto Carvalho
 

Mais de Jose Augusto Carvalho (18)

Trabalhando com Módulos no Puppet
Trabalhando com Módulos no PuppetTrabalhando com Módulos no Puppet
Trabalhando com Módulos no Puppet
 
Orquestração com Mcollective
Orquestração com McollectiveOrquestração com Mcollective
Orquestração com Mcollective
 
Infraestrutura ágil com Puppet - CISL
Infraestrutura ágil com Puppet - CISLInfraestrutura ágil com Puppet - CISL
Infraestrutura ágil com Puppet - CISL
 
Cultura DevOps - Integração entre infra e devel
Cultura DevOps - Integração entre infra e develCultura DevOps - Integração entre infra e devel
Cultura DevOps - Integração entre infra e devel
 
Infraestrutura como código com Puppet e Mcollective
Infraestrutura como código com Puppet e McollectiveInfraestrutura como código com Puppet e Mcollective
Infraestrutura como código com Puppet e Mcollective
 
Cultura DevOps e integração entre infra e devel
Cultura DevOps e integração entre infra e develCultura DevOps e integração entre infra e devel
Cultura DevOps e integração entre infra e devel
 
Oficina de infraestrutura como código (apresentando o Puppet)
Oficina de infraestrutura como código (apresentando o Puppet)Oficina de infraestrutura como código (apresentando o Puppet)
Oficina de infraestrutura como código (apresentando o Puppet)
 
Ferramentas para infraestrutura ágil
Ferramentas para infraestrutura ágilFerramentas para infraestrutura ágil
Ferramentas para infraestrutura ágil
 
Conhecendo o Wordpress
Conhecendo o WordpressConhecendo o Wordpress
Conhecendo o Wordpress
 
Monitoração avançada com Zabbix 2
Monitoração avançada com Zabbix 2Monitoração avançada com Zabbix 2
Monitoração avançada com Zabbix 2
 
O que é DevOps afinal?
O que é DevOps afinal?O que é DevOps afinal?
O que é DevOps afinal?
 
Palestra Puppet Hora Livre
Palestra Puppet Hora LivrePalestra Puppet Hora Livre
Palestra Puppet Hora Livre
 
Oficina Puppet latinoware
Oficina Puppet latinowareOficina Puppet latinoware
Oficina Puppet latinoware
 
Puppet webcast 4linux
Puppet webcast 4linuxPuppet webcast 4linux
Puppet webcast 4linux
 
Oficina Puppet - Aprenda a Gerenciar Configurações
Oficina Puppet - Aprenda a Gerenciar ConfiguraçõesOficina Puppet - Aprenda a Gerenciar Configurações
Oficina Puppet - Aprenda a Gerenciar Configurações
 
Puppet Cloud IaaS
Puppet Cloud IaaSPuppet Cloud IaaS
Puppet Cloud IaaS
 
Consegi 2011: Puppet
Consegi 2011: PuppetConsegi 2011: Puppet
Consegi 2011: Puppet
 
Consegi 2011: Ganeti + Puppet
Consegi 2011: Ganeti + PuppetConsegi 2011: Ganeti + Puppet
Consegi 2011: Ganeti + Puppet
 

Último

Manual-de-Credenciamento ANATER 2023.pdf
Manual-de-Credenciamento ANATER 2023.pdfManual-de-Credenciamento ANATER 2023.pdf
Manual-de-Credenciamento ANATER 2023.pdf
WELITONNOGUEIRA3
 
TOO - TÉCNICAS DE ORIENTAÇÃO A OBJETOS aula 1.pdf
TOO - TÉCNICAS DE ORIENTAÇÃO A OBJETOS aula 1.pdfTOO - TÉCNICAS DE ORIENTAÇÃO A OBJETOS aula 1.pdf
TOO - TÉCNICAS DE ORIENTAÇÃO A OBJETOS aula 1.pdf
Momento da Informática
 
Certificado Jornada Python Da Hashtag.pdf
Certificado Jornada Python Da Hashtag.pdfCertificado Jornada Python Da Hashtag.pdf
Certificado Jornada Python Da Hashtag.pdf
joaovmp3
 
História da Rádio- 1936-1970 século XIX .2.pptx
História da Rádio- 1936-1970 século XIX   .2.pptxHistória da Rádio- 1936-1970 século XIX   .2.pptx
História da Rádio- 1936-1970 século XIX .2.pptx
TomasSousa7
 
Logica de Progamacao - Aula (1) (1).pptx
Logica de Progamacao - Aula (1) (1).pptxLogica de Progamacao - Aula (1) (1).pptx
Logica de Progamacao - Aula (1) (1).pptx
Momento da Informática
 
DESENVOLVIMENTO DE SOFTWARE I_aula1-2.pdf
DESENVOLVIMENTO DE SOFTWARE I_aula1-2.pdfDESENVOLVIMENTO DE SOFTWARE I_aula1-2.pdf
DESENVOLVIMENTO DE SOFTWARE I_aula1-2.pdf
Momento da Informática
 

Último (6)

Manual-de-Credenciamento ANATER 2023.pdf
Manual-de-Credenciamento ANATER 2023.pdfManual-de-Credenciamento ANATER 2023.pdf
Manual-de-Credenciamento ANATER 2023.pdf
 
TOO - TÉCNICAS DE ORIENTAÇÃO A OBJETOS aula 1.pdf
TOO - TÉCNICAS DE ORIENTAÇÃO A OBJETOS aula 1.pdfTOO - TÉCNICAS DE ORIENTAÇÃO A OBJETOS aula 1.pdf
TOO - TÉCNICAS DE ORIENTAÇÃO A OBJETOS aula 1.pdf
 
Certificado Jornada Python Da Hashtag.pdf
Certificado Jornada Python Da Hashtag.pdfCertificado Jornada Python Da Hashtag.pdf
Certificado Jornada Python Da Hashtag.pdf
 
História da Rádio- 1936-1970 século XIX .2.pptx
História da Rádio- 1936-1970 século XIX   .2.pptxHistória da Rádio- 1936-1970 século XIX   .2.pptx
História da Rádio- 1936-1970 século XIX .2.pptx
 
Logica de Progamacao - Aula (1) (1).pptx
Logica de Progamacao - Aula (1) (1).pptxLogica de Progamacao - Aula (1) (1).pptx
Logica de Progamacao - Aula (1) (1).pptx
 
DESENVOLVIMENTO DE SOFTWARE I_aula1-2.pdf
DESENVOLVIMENTO DE SOFTWARE I_aula1-2.pdfDESENVOLVIMENTO DE SOFTWARE I_aula1-2.pdf
DESENVOLVIMENTO DE SOFTWARE I_aula1-2.pdf
 

Documentando de forma Ágil (usando dokuwiki)

  • 1. WIKI Documentado de forma ágil. José Augusto (Guto) Carvalho gutocarvalho@gmail.com @gutocarvalho Tuesday, April 24, 12
  • 2. Agenda Entendendo Wiki Sintaxe Estrutura Administração Controles de Acesso 46 Slides - 60 a 80 Minutos Tuesday, April 24, 12
  • 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/Wiki Tuesday, April 24, 12
  • 5. Para o SysAdmin/DevOps qual parte da documentação é a mais importante? Tuesday, April 24, 12
  • 6. Textos c/ Perfumarias? Formatação complexa? Design refinado? Formato fechado? Isso realmente importa? Tuesday, April 24, 12
  • 7. Nada disso importa, o que importa é o conteúdo. Tuesday, April 24, 12
  • 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ápida Tuesday, April 24, 12
  • 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. 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. 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
  • 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 namespaces Tuesday, April 24, 12
  • 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 PostgreSQL Tuesday, April 24, 12
  • 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. 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. 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. 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
  • 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/Markdown Tuesday, April 24, 12
  • 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 3 Tuesday, April 24, 12
  • 24. Mão na Massa entendendo na prática como criar e editar wikipages Tuesday, April 24, 12
  • 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 Playground Tuesday, April 24, 12
  • 26. [[area:nome|descrição]] [[playground:teste do guto|Página teste do Guto]] criando página Tuesday, April 24, 12
  • 27. //Itálico// __sublinhado__ **negrito** <del> tachado <del> Formatação Simples Tuesday, April 24, 12
  • 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 Listas Tuesday, April 24, 12
  • 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]] links Tuesday, April 24, 12
  • 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}} Imagens Tuesday, April 24, 12
  • 31. ^Nome^Telefone^ | Jose Augusto | 5555-5555 | | Fernando | 5555-5555 | Tabelas Tuesday, April 24, 12
  • 32. Execute o comando (dois espaços) comando 1 comando 2 <code> conteúdo longo </code> Destacando Texto Tuesday, April 24, 12
  • 33. <file php arquivo.php> <?php echo "hello world!"; ?> </file> Conteúdo Arquivo Tuesday, April 24, 12
  • 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. Perguntas? (5 min) José Augusto (Guto) Carvalho gutocarvalho@gmail.com http://gutocarvalho.net @gutocarvalho Tuesday, April 24, 12
  • 46. Obrigado José Augusto (Guto) Carvalho gutocarvalho@gmail.com http://gutocarvalho.net @gutocarvalho Tuesday, April 24, 12