William Koch
William Koch's Blog

William Koch's Blog

Gestão de Conhecimento de TI, parte 1

Definições iniciais

William Koch's photo
William Koch
·Nov 21, 2021·

3 min read

Trabalho em um pequeno departamento de TI com uns 10 funcionários, nem todos técnicos, e alguns estagiários e notei vários problemas relacionados e como:

  • Falta de padronização nos procedimentos;
  • Fator de ônibus muito baixo: só uma pessoa sabe resolver x problema;
  • Conhecimento isolado em Ilhas e disperso em múltiplas fontes;

Sugeri iniciarmos um projeto de documentação interna, pois poderia trazer os seguintes benefícios:

  • Um funcionário pode tirar dúvidas sobre os sistemas sem incomodar os colegas;
  • Qualquer funcionário pode fazer qualquer procedimento, desde que tenha o nível de acesso;
  • Ninguém será incomodado nas férias;
  • Fica mais fácil melhorar o fluxo de trabalho, identificando gargalos ou procedimentos desnecessários ou que deveriam ser de outro setor;
  • Aumenta o fator de ônibus e facilita a integração de novos funcionários.

Quando se falou em não incomodar ninguém nas férias a equipe concordou rapidamente, e após uma breve análise das alternativas, decidimos utilizar o Confluence para gerir a documentação, principalmente por ter um editor bastante avançado e por permitir exportar o conteúdo para HTML e PDF com razoável facilidade.

Decidida a ferramenta, perdemos algum tempo em paralisia de análise tentando definir a melhor maneira de estruturar a documentação e que padrão utilizar para os documentos. Porém, como poderíamos definir a melhor maneira sem ter experiência e sem poder sequer imaginar como seria a documentação pronta?

Considerando que no Confluence o conteúdo pode ser reorganizado entre espaços e pastas com grande facilidade e que a formatação dos documentos também pode ser alterada a qualquer momento com a segurança do histórico de alterações, decidimos que seria melhor por a mão na massa e começar a documentação o quanto antes sem se preocupar tanto com a estrutura de pastas e menos ainda com o padrão interno dos documentos, e que, conforme os padrões fossem emergindo naturalmente da experiência de uso do Confluence e da elaboração da documentação, esta poderia ser reorganizada e reformatada para atender ao padrão.

Elaboramos, em poucas horas, um mapa mental com uma estrutura básica para fazer a primeira divisão do conteúdo em espaços, e começamos a registrar os documentos. Neste primeiro momento definimos uma regra: todos devem registrar no Confluence qualquer conhecimento que ainda não esteja registrado, não importando a qualidade, organização, formatação etc. O foco é fazer um despejo rápido de conhecimentos sem que isso atrase os serviços dos funcionários e sem causar paralisia por perfeccionismo.

A ideia é que, inicialmente, o conteúdo seja reformatado e revisado por funcionários administrativos. E com o tempo, que dessa experiência surjam padrões de documentos que possam ser aplicados a todos os documentos do mesmo tipo. Eventualmente, os próprios funcionários técnicos já poderão criar novos documentos seguindo os padrões existentes que serão salvos em templates do Confluence.

Nas minhas pesquisas iniciais, este post da Divio que encontrei no Hacker News ajudou a entender melhor os tipos de documentos. Até agora, já identifiquei que teremos pelo menos 3 tipos dos documentos especificados pela Divio:

  1. Referência: Páginas de introdução e informação. Informa sobre o que é o software etc, e tem qualquer informação que possa ser necessária no dia a dia, como IPs etc. Serve para agrupar outros conteúdos relacionados e para se encontrar com facilidade as informações sobre os sistemas etc.;
  2. Guia: Documentação detalhada de funcionalidades de software etc. Serve para aprender a usar, tirar dúvidas de alguma funcionalidade pouco utilizada etc.;
  3. Procedimento: Instrução de como realizar certo serviço do início ao fim. Pode incluir outros procedimentos menores como parte de um procedimento maior;

Minha expectativa de funcionamento para estes tipos de documentos é como no exemplo abaixo:

├── Confluence
    └── Software (Espaço do Confluence)
        └── WebMail (Referência)
        |   └── WebMail Admin (Guia)
        |       ├── Criar email (Procedimento)
        |       └── Alterar grupos (Procedimento)
        └── WebMail Email (Guia)
 
Share this