Exibir código-fonte para Boas Praticas para a Documentacao de Infraestruturas de Redes e Servicos do Provedor

=== Boas Práticas para a Documentação de Infraestruturas de Redes e Serviços do Provedor ===

==== Nota sobre direitos autorais, termo de uso e isenção de responsabilidade ====
Consulte [[Direitos Autorais Licenca de Uso|os direitos autorais e licença de uso antes de usar este material em seu blog, ou incorporá-lo a qualquer trabalho de natureza acadêmica ou de destinação profissional]].

'''Autor: [https://wiki.brasilpeeringforum.org/w/Usu%C3%A1rio:Leonardo.furtado Leonardo Furtado]'''

=== Introdução ===
Em mais um artigo na Wiki do Brasil Peering Forum (BPF), dissertarei desta vez a respeito da importância de uma criteriosa, consistente e atualizada documentação de toda a nossa infraestrutura e serviços de redes. Os conceitos abordados aqui são válidos tanto para os provedores de acesso de Internet (ISPs) quanto para qualquer ambiente de redes e em qualquer mercado vertical. Aproveitarei a oportunidade para recomendar alguns procedimentos e ferramentas que podem ser usados para você ter padrões de documentação excelentes e amplamente funcionais sobre a sua rede. Aprecie este artigo sem moderação!

==== O significado da palavra documentação ====
(Em tom irônico aqui)

'''Documentação'''

substantivo feminino

1. Ato, processo ou efeito de documentar.

2. Reunião de documentos com o propósito de esclarecer ou provar alguma coisa.

3. Somatório de documentos que identifique alguém ou alguma coisa (empresa, instituição etc.).

4. A totalidade ou cada um dos processos de seleção, classificação e organização das informações constantes dos documentos de qualquer natureza.

5. Organização do acervo de uma instituição, segundo os preceitos da documentologia. Ou acervo gráfico de uma instituição, organizado segundo os mesmos preceitos. 

Origem

- ETIM lat. documentatĭo,ōnis 'advertência, aviso' < lat. documēntum,i 'lição, exemplo"

=== A importância da documentação de infraestruturas e aparatos tecnológicos ===
Saindo do tom irônico e entrando no nosso universo aqui, que é o que realmente importa para a comunidade que conta com o BPF para aprimorar seus conhecimentos e processos.

A verdade é que a documentação - ou a qualidade desta - em muitas empresas do setor é '''''<u>bastante precária e deixa muito a desejar!</u>''''' Há um monte de coisas que posso falar com bastante propriedade no meu trabalho, palestras e na wiki do BPF, e este tema é seguramente uma destas situações. Talvez o problema aqui seja a falta de percepção dos valores e benefícios por parte de muitas empresas e profissionais acerca do que uma boa gestão de documentação é capaz de proporcionar em termos melhorias absurdas de indicadores do negócio, incluindo técnicos, operacionais e financeiros. Para muitos indivíduos, a documentação é apenas um processo burocrático de manutenção de algumas planilhas e diagramas ou topologias em dia. Em meu entendimento, estas empresas e indivíduos falham ou não sabem conectar as relações de benefícios tangíveis.

A documentação de uma infraestutura, incluindo todos os seus componentes, serviços e respectivas configurações é indispensável para que uma empresa consiga manter níveis de serviços e disponibilidades bem sustentáveis. É através de uma sólida, consistente e atualizada documentação que você e a sua empresa poderá tomar decisões mais acertadas, localizar informações importantes e em momentos críticos, encurtar drasticamente o tempo e esforços gastos nas ações de diagnósticos e suporte de falhas na rede; planejamento de capacidades, planejamento estratégico, engenharia de redes, otimização da operação, ativação e suporte de assinantes e serviços, dentre tantas situações fundamentais para que uma empresa consiga fazer o certo e na hora certa.
[[Arquivo:Bpf-doc-mindmap.jpg|centro|miniaturadaimagem|900x900px|Mapa mental sintetizando os conceitos propostos deste artigo]]

Baixe este mapa mental aqui: https://wiki.brasilpeeringforum.org/images/0/05/Bpf-doc-mindmap-pdf.pdf

==== Onde exatamente as documentações serão úteis para você, a sua empresa, e seus clientes? ====
Esta seção é o "coração" do artigo, sem sombra de dúvidas a mais importante de tudo aquilo que busco dissertar nesta publicação.

Talvez você ainda não compreenda a importância da documentação (no geral) para os resultados técnicos e de negócios de sua empresa! Esta seção aqui ajudará muito neste sentido/entendimento.

Separei algumas possibilidades envolvendo princípios de documentação como um todo, sendo que algumas das situações citadas acima serão tratadas neste artigo - realmente não dá para abordar tudo num único artigo! Acho que a melhor forma de você compreender bem a importância da documentação para uma empresa é destacando situações e contextos onde cada tipo de documento ou "artefato" pode ser empregado. Alguns exemplos aqui:
{| class="wikitable"
|'''Situação'''
|'''Obervações  e comentários gerais'''
|-
|'''Processo de controle de inventário'''
|As empresas precisam de controles efetivos sobre todo o inventário relacionado aos componentes de infraestrutura. Como realmente não dá para listar todas as possibilidades em um único artigo, tentarei focar aqui em alguns bons exemplos e situações:
* Controle e gestão patrimonial, fomentando medidas para localização e rastreamento de ativos, e prevenção de extravio de materiais
* Compreensão do ''custo total de propriedades'' (TCO) da infraestrutura e das métricas associadas ao ''retorno de investimentos'' (ROI)
* Organização e planejamento financeiro para projetos nas áreas de concessão e expansão
* Fornecimento da associação devida entre clientes, serviços e ativos de infraestrutura envolvidos na viabilidade e disponibilidade do serviço de cada cliente
* Fornecimento de insumos para maior clarificação dos controles de segurança da informação
* Identificação e controle da relação entre software, licenças de funcionalidades e dispositivos envolvidos
* Alimentação e aprimoramento dos processos de diagramação do bloco de confiabilidade da infraestrutura (SPOF, MTBF, MTTR, MDT) e do SLA geral
* Identificação e controle dos contratos de serviço e suporte (vigentes, a vencer, expirados) por item junto aos fornecedores/fabricantes (fundamental!)
* Permitir melhor relação entre equipamento e software e promover benefícios para as ações de manutenção de software do parque
* Fornece analíticos de materiais empregados para planejamentos diversos, incluindo logística (estoque, reposição, ''lead time'') e financeiro (ciclos de compras e afins), o que, por sua vez, promove melhor controle patrimonial e reduz substancialmente o desperdício de materiais
|-
|'''Processo e padronização de nomenclatura de dispositivos, circuitos e elementos gerenciados'''
|Muitos profissionais optam por  nomear seus dispositivos com base em critérios puramente pessoais. Por exemplo, alguns indivíduos são fãs da trilogia Matrix, e costumam nomear seus equipamentos com nomes tais como "Neo", "Morpheus", "Trinity",  etc. 

Já outros indivíduos são fissurados pela mitologia Nórdica, e curtem nomear seus  equipamentos com nomes tais como "Odin", "Thor", "Loki",  "Sif", etc.

Enfim, você compreendeu a pegada aqui. Particularmente eu não vejo problemas quanto a isso, exceto a clara e óbvia baixa aderência entre estes equipamentos e como estes são tratados na condição de objetos gerenciados pelos sistemas da organização.

Saiba que há formas mais efetivas de nomear equipamentos, servidores, e circuitos de rede. E, não, não é apenas burocracia. Há um propósito de verdade.
|-
|'''Processo e documentação de rotas ópticas e conexões físicas no geral'''
|Tão importante quanto ter uma documentação efetiva dos equipamentos da rede é termos a mesma coisa sobre as conexões físicas da rede:
* Permite organizar e manter sob controle as características ópticas ou eletromecânicas acerca do enlace físico, tais como interfaces de conexão, transceptores empregados, potência/atenuação/perdas, características de sinais, modulação, codificação, distâncias, designações de circuitos contratados, etc.
* Permite manter sob controle as posições das conexões nos ''patch panels'' e distribuidores ópticos internos e gerais para afins de intervenção e manutenção
* Permite antecipar a disponibilidade de rotas óticas, dutos, calhas, e tudo aquilo que estiver associado com a passagem de cabeamento para novas instalações
* Permite antecipar cenários de falhas e indisponibilidades em cenários de rompimentos de cabeamento, rotas ópticas e afins
* Permite documentar e arquivar relatórios de testes de conformidade dos circuitos para um ''baseline'' efetivo, revisão de parâmetros de transmissão e suporte
|-
|'''Processo e padronização e controle de alocação de VLAN IDs'''
|Por mais simples ou trivial que isto possa parecer, entenda que é de suma importância que você faça o devido controle de alocação de VLAN IDs.

Quais clientes estão posicionados e em quais VLANs, quais entroncamentos autorizam quais destes VLAN IDs, seja isto em regime 802.1q clássico ou em Q-in-Q, até mesmo porque o espaço de VLAN IDs é bem limitado em muitos projetos de redes Metro, e isto nos obriga a termos um ótimo controle dos usuários e serviços de cada VLAN ID
|-
|'''Processo e padronização e controle de Pseudowire IDs'''
|Assim como no caso do VLAN ID, há  outros tipos de identificadores relacionados a serviços gerais, tais como projetos com tecnologias de L2VPN que empreguem um VC (''virtual circuit'') ID ou ''pseudowire ID''. Sempre que possível tentamos usar como ''pw-id'' o ID da própria VLAN do usuário/serviço nos projetos mais simples. 

No entanto, em alguns casos, o ''pw-id'' é derivado com base em outros critérios que vão além do ID da VLAN. Isto pode ser muito útil em situações de suporte de clientes de serviços eventualmente impactados por indisponibilidades ou por degradação de performance da rede
|-
|'''Processo e padronização e controle da Política de Roteamento (incluindo Communities do BGP e outros)'''
|A política de roteamento representa muito mais que comandos e parâmetros inseridos na configuração de um equipamento.
* Na verdade, a política de roteamento precisa ser compreendida e documentada antes mesmo de tornar-se uma configuração (sintaxe) de elementos de rede
* Mais importante que comandos e sintaxes é a clarificação de propósitos, objetivos, casos de uso, etc. 
* Recomenda-se que a sua empresa faça um controle bem refinado sobre as Communities do BGP,  a função e como cada uma delas deve ser usada para a política de roteamento da empresa. E isto é válido para todas as famílias de endereços IP suportadas e em uso pela infraestrutura
* Qual é o seu critério para o plano de Communities? Como os números/valores são derivados? Há alguma lógica envolvida no processo? Então, documente!
|-
|'''Processo e planejamento e controle de alocação e distribuição de blocos de endereços IPv4 e IPv6'''
|O controle minucioso de alocações de blocos de endereços IPv4 e IPv6 é fundamental para a resolução de vários desafios associados às redes IP:
* Em primeiro momento, permite registrar quais assinantes consomem quais endereços ou blocos de endereços do provedor 
* Dissemina informações auditáveis para o planejamento da utilização destes blocos, com benefícios para as necessidades de segurança da informação, engenharia de redes (ex: refinamento do roteamento IGP e BGP, sumarização/agregação, etc.), e atribuições legais do ISP (resposta aos requerimentos judiciais e inquéritos policiais)
* Fornece maior controle e organização de alocação de endereços ou blocos de endereços, assim como a revogação ou estorno destes
* Uma vez que toda a gestão de endereços é profissionalizada neste sentido, há uma redução significativa quanto ao desperdício de endereços do(s) bloco(s) do ISP
|-
|'''Processo, padronização e controle de gestão de mudanças'''
|Uma das minhas maiores críticas no que diz respeito ao gerenciamento de configurações do ISP é a falta de processos e padrões para a construção das configurações necessárias para a ativação de serviços de assinantes corporativos, residenciais, telcos e afins.
* Permite a Engenharia do ISP estabelecer uma configuração homologada ("padrão a ser adotado") para a ativação de cada produto do ISP para seus clientes
* A configuração dos elementos é padronizada no regime por '''''Tecnologia x Plataforma x Produto'''''. E isto oferece ótima consistência para que não haja desvios sobre os padrões (de configuração) definidos pela engenharia do ISP, o que, por sua vez, facilita o entendimento e suporte sobre as tecnologias empregadas.
* A padronização das configurações - mantida em processos de documentações - reduz a complexidade geral da rede, e acelera o tempo de resposta nas ações de suporte
* Permite clarificar e documentar um processo específico para a iniciação das configurações propostas e em seus respectivos equipamentos, além de promover uma cadeia de aprovação para a janela de ativação/manutenção do serviço, ou seja, aprimora os indicadores de GMUD
|-
|'''Processo e arquivamento de configurações de elementos e serviços'''
|Alinhado com o processo citado anteriormente, fornece os seguintes controles e objetivos:
* Podendo ser um controle simples e manual, porém efetivo, ou, então, completamente automatizado por sistemas específicos contendo as funcionalidades apropriadas para estes propósitos
* Permite o ''versionamento'' de todas as configurações associadas a cada assinante/cliente ativo na infraestrutura, incluindo o histórico de mudanças, justificativas de cada mudança, sintaxes e semânticas aplicadas, etc.
* Possibilita compreender melhor os custos operacionais associados a cada uma das mudanças em formato temporal e confrontados com as suas respectivas justificativas, onde e quando cobrar por estas mudanças, etc.
* Fornece rápido entendimento para times de suporte interessados em sanear problemas associados ao produto contratado pelo cliente, reduzindo drasticamente o tempo médio de restauração, sustentação do SLA contratado, e aumento de satisfação de clientes atendidos pelo centro de operação de redes do ISP
* Poderá ser feito de forma isolada, ou combinada com sistemas de gerenciamento com funcionalidades específicas
|-
|'''Processo e controle de gestão de riscos e suporte a incidentes'''
|Para ser efetivo, este processo precisa estar conectado a outras áreas de outros processos.
* Processo que documenta cada ação necessária para a resolução de cada tipo de incidente possível na infraestrutura
* Permite excepcional redução do MTTR e manutenção do SLA, o que se traduz em menos esforços e custos operacionais e na maior satisfação de clientes
* Permite exercitar cenários de falhas e análises mais adequadas de áreas de riscos para o negócio
|-
|'''Processo de controle e arquivamento de soluções homologadas'''
|Diferentemente do processo de arquivamento de configurações de elementos e serviços por assinante ou cliente, este processo tem relação com a cadeia de conhecimentos necessários para gerir soluções mais complexas ou diferenciadas para diversas áreas da organização. Por exemplo:
* Arquivamento dos conceitos de soluções completas homologadas pela área de Engenharia da organização, incluindo a lista de materiais ou BoM (componentes de hardware, software licenças, etc., e custos associados) referentes a um produto (solução) específico do portfólio do ISP, e estendendo isto para as demais (todas) soluções deste portfólio
* Construção de materiais técnicos e comerciais que consolidem o entendimento estratégico e tecnológico sobre cada solução, tais como apresentações orientadas a tomada de decisões de caráter executivo (''Business Decision Makers'' (BDM)) e de caráter técnico (''Technical Decision Maakers'' (TDM)), além de folhetos, datasheets, prospecções, áreas do website, etc.
* Capacitar as áreas internas e em suas respectivas alçadas sobre os conhecimentos necessários para a melhor gestão do portfólio destas soluções, tais como ''sales pitch'', ''battle decks'', vantagens e benefícios para os clientes (e, em caráter de confidencialidade, para o próprio ISP), logística, ativação/provisionamento, operação e suporte, etc.
* Promover excelente enquadramento da relação de valor de cada solução do portfólio do ISP, tais como cenários de TCO e ROI, objetivos e necessidades atendidas com cada solução em aderência às particularidades de cada mercado vertical, dentre outras iniciativas deste porte
* Permite aprimorar os processos comerciais relacionados à geração de ''leads'' e captação de novas oportunidades, fazendo com que o ISP tenha um ticket melhor/mais atraente com serviços de valor agregado (SVA), o que, por sua vez, melhora a competitividade do setor e posiciona o ISP como ''player'' mais estratégico e atraente para os segmentos que atende
* Aprimora substancialmente a gestão de portfólio de soluções do ISP com argumentos de indústria para maior fidelidade no atendimento das necessidades e particularidades dos mercados verticais, e, também, uma gestão mais estratégica do mapa de competitividade do setor
* Por último, mas não apenas isto ("''last but not least''"), com toda a percepção de valor do portfólio, o ISP consegue reunir argumentos muito sólidos para investimentos continuados de suas próprias infraestruturas, o que promove benefícios técnicos e operacionais para tudo aquilo que é comercializado (produtos e soluções) sobre o topo desta. Todos saem ganhando (clientes e ISP)
|-
|'''Processo de controle e arquivamento de diagramas representativos das conexões físicas, lógicas e do funcionamento de tecnologias-chave'''
|Da máxima "''entendeu'' ''ou'' ''quer que eu desenhe?''", os diagramas são muito úteis, indispensáveis até, para que as área técnicas da organização consigam operar e suportar todo o parque tecnológico. Alguns exemplos, mas, para efeitos de simplicidade e objetividade, os termos "topologia" e "diagrama" serão intercambiáveis:
* ''Topologias representativas da construção física da rede.'' Ou seja, como os elementos passivos e ativos da infraestrutura estão conectados, as portas/interfaces envolvidas em cada conexão, posições de ''patch panels'', DGO, DIO; designação de circuitos, designação de rotas ópticas, localização física de cada equipamento (site, fileira, rack, bastidor), etc.
* ''Topologias representativas da construção lógica L2 do backbone''. Aqui documentamos no formato visual as principais configurações e características de funcionamento de recursos L2 indispensáveis para as missões de resiliência, disponibilidade e controle de loop, em adição a outros prováveis mecanismos L2 importantes para o funcionamento da rede do ISP
* ''Topologias representativas da construção lógica L3 do backbone''. Na questão L3, a documentação visual de conceitos tais como a distribuição e alocação das subredes IPv4 e IPv6 internas, áreas OSPFv2 e OSPFv3, posicionamento dos roteadores ABR, ASBR, pontos de redistribuição de rotas; interfaces ''core-facing'' habilitadas para o MPLS/MPLS-TE, etc.
* ''Topologias representativas da construção lógica do BGP''. Sobre os mesmos diagramas acima, podendo ser em uma camada dedicada, a disposição de configurações essenciais do BGP para o ISP, tais como o sistema autônomo, o posicionamento dos roteadores ou clusters de ''Route Reflectors'', confederações, famílias de endereços suportadas por cada roteador BGP, etc.
* ''Topologias representativas do mapa de emparelhamentos do BGP''. Aqui documentamos com mais detalhes como todas as sessões IBGP e EBGP são construídas, os respectivos peers (IX, Trânsito, PNI, CDNs, etc.), além de destacarmos propriedades importantes para cada sessão tais como interfaces físicas ou lógicas, VLANs, endereços IP, e policies IN e OUT usadas para cada sessão.
* ''Topologias representativas da ativação de serviço de clientes''. Especialmente ou principalmente os clientes corporativos, pois estes são mais críticos e exigentes em termos de SLA. Aqui destacamos num único diagrama o L1, L2 e L3, fornecendo todos os detalhes de caracterização, configuração, provisionamento e suporte daquele assinante corporativo. Isto deve ser anexado  juntamente com as configurações de elementos e serviços de cada cliente
* ''Topologias representativas do mapa de riscos, prevenção e recuperação de falhas''. Como o próprio nome sugere, aqui produzimos os diagramas de bloco de confiabilidade da infraestrutura, destacando o SLA (derivado a partir do MTBF, MTTR e MDT) de cada perímetro da rede, identificação de zonas de falhas em série e em paralelo, etc. O objetivo aqui é compreendermos visualmente como as falhas poderão impactar o negócio
|}
Acho que a essa altura do campeonato você já deva ter argumentos de sobra para "debruçar" sobre o tema de forma mais profissional e responsável, certo?

=== Antes de documentar a sua rede e tudo o que funciona no topo desta, comece pelo gerenciamento de processos! ===
Confesso que há um desafio nesta questão sobre "como fazer", mas podemos resumir que isto representa duas possibilidades: '''''<u>manual</u>''''' ou por '''''<u>gerenciamento eletrônico de documentos</u>''''' (GED). Discutiremos ambas as alternativas neste artigo, mais a frente. Todavia, é altamente recomendado que isto seja feito conforme as abordagens pautadas pelos princípios de '''''Business Process Management''''' ou Gerenciamento por Processos do Negócio (BPM) e '''''Business Process Model and Notation''''' (BPMN), que é representação visual destes processos - já que BMP e BPMN são coisas distintas, mas que se complementam para os mesmos objetivos.

A minha recomendação é que os processos sejam definidos em primeiro momento ('''<u>''isto é, antes mesmo de você sair criando planilhas e diagramas, ou o que for!''</u>''') consequentemente revisados, refinados, até que sejam bem compreendidos e aprovados pela organização. Ou seja, '''<u>''tudo começa pelos processos''</u>'''! Não, não é burocracia: é planejamento com foco em resultados! Afinal de contas, você quer êxito/resultados, e não esforços significativos sem propósitos definidos.

Falemos um pouco sobre os processos então. Você poderá pesquisar, estudar e construir processos usando ferramentas simples e de encaixe um tanto "manual" (planilhas, documentos convencionais, diagramação e afins), ou partir para conceitos mais especializados para este propósito, que seriam, neste caso, as propostas pelos conceitos BPM e BPMN. De certa forma, é possível construir e manter processos através de uma abordagem manual de controle, revisão e aprovação, e hospedar tudo isto em um servidor de arquivos da empresa. Os principais desafios com esta abordagem estão relacionados ao <u>''compliance''</u> (colaboradores e clientes seguindo fielmente os processos) e também a dinâmica, eficácia e flexibilidade quanto à manutenção/revisão destes processos. Por isto que insisto que você considere a contratação de serviços ou ferramentas que façam melhor este trabalho de construção, manutenção, revisão e conformidade de processos, em adição ao cumprimento de boas práticas de gerenciamento de processos.<blockquote>'''''Faço apenas uma observação muito importante aqui: tais sistemas e serviços obviamente não são específicos e não devem ser limitados apenas para os propósitos de documentação da rede (foco deste artigo), mas devem incluir os demais processos gerais da empresa. Apesar de estar focando aqui na questão da documentação de redes, quero que você entenda que a sua empresa deverá possuir processos para praticamente tudo; todas as ações dos setores e respectivos centros de custos. Aproveite esta oportunidade para pensar um pouco da caixa (isto é, fugindo até mesmo do tema/foco do artigo) para fazer a sua empresa funcionar "nos trinques"!'''''</blockquote>Aproveitarei a oportunidade para recomendar a sua revisão ou consulta sobre algumas opções disponíveis no mercado para esta questão de gerenciamento dos processos.
[[Arquivo:Bpf-doc-1.png|centro|miniaturadaimagem|900x900px|Gerenciamento de processos (criação, edição, utilização, conformidade)]]

==== Sistemas de gerenciamento de processos ====
* '''SYDLE ONE''' (https://www.sydle.com/br/)
* '''Bonita BPM''' (https://www.bonitasoft.com/)
* '''Imixs Workflow''' (https://www.imixs.org/)
* '''ProcessMaker''' (https://www.processmaker.com/)
* '''HEFLO! Documentação''' (https://www.heflo.com/)
* '''SoftExpert BPM''' (https://www.softexpert.com/pt-br/solucao/gestao-de-processos-de-negocio-bpm/)
* '''Holmes''' (https://holmesdoc.com.br/)
* '''Bizagi BPMN Modeler''' (https://www.bizagi.com/pt/produtos/bpm-suite/modeler)
* '''ARIS Express''' (https://www.ariscommunity.com/aris-express)
* '''BPMN.io''' (http://bpmn.io/)
* '''Yaoqiang BPMN Editor''' (https://sourceforge.net/projects/bpmn/)
* '''Draw.io''' (http://draw.io/)
* '''Modelio''' (https://www.modelio.org/)
* '''Pipefy''' (https://www.pipefy.com/pt-br/)
* '''systemHUB''' (https://www.systemhub.com/)
* '''Adonis NP''' (https://uk.boc-group.com/adonis/)

===== Dicas: o que você deve fazer em seguida na questão específica dos processos de documentação =====
Procurarei ser bem objetivo aqui, numa ordem sequencial, com relação ao estabelecimento de processos de documentação da rede e de seus serviços:
# Identifique quais tipos de documentações você precisa manter sobre a sua rede, serviços, produtos, soluções, tecnologias primárias, clientes, etc.
# Identifique a qualidade ou profundidade requerida de detalhes e características para cada caso, e com a finalidade de cada documento ser útil para a missão o qual se destina.
# Construa os processos necessários para criação e manutenção de cada tipo de artefato desejado/necessário para o seu negócio. Não saia documentando "a torto e a direito" a sua rede: pense, planeje, organize e faça!
# Identifique e nomeie as propriedades da informações de cada artefato:
## Elaboração do padrão estrutural de cada documento (introdução, justificativa, objetivos, índice, áreas, seções, blocos, etc.), além das respectivas indexações, categorizações, metadados e ''tags''.
# Identifique os padrões de classificação de cada documento/artefato, e as restrições de uso e compartilhamento de cada caso:
## ''<u>Restrito da companhia</u>'', pois revela segredos, estratégias comerciais, dados financeiros internos, dados de funcionários e colaboradores, etc.
## ''<u>Altamente confidencial</u>'', pois revela informações bastante sigilosas sobre as propriedades da rede, além de poder identificar indivíduos e organizações protegidas por um contrato. Requer assinatura de NDA para compartilhamento de partes específicas apenas do documento.
## ''<u>Confidencial</u>'', pois revela informações que são vedadas para o domínio público. Requer assinatura de NDA para compartilhamento com terceiros (ex: fornecedores e parceiros).
## ''<u>Público</u>'', documentos que podem ser disponibilizados em caráter de domínio público.
# Identifique a caracterização de propriedade do documento:
## <u>''Impactos sobre os indivíduos (colaboradores e clientes):''</u> como o documento e/ou o respectivo processo afetará positivamente o desempenho e resultados das funções e atribuições destes.
## <u>''Impactos sobre o mau uso da informação:''</u> as consequências negativas para o negócio ou a operação em caso de mau uso das informações governadas pelo documento.
## ''<u>Valor atribuído ao documento:</u>'' para representar corretamente o quanto o artefato é valioso para os diversos objetivos os quais é destinado, seja pela sua utilidade ou pelo seu valo estratégico.
# Estabeleça as funções (''roles'') para a gestão de documentos:
## <u>''Autor original do documento''</u>, ou ''ownership.''
## <u>''Custódia ou mantenedor do documento:''</u> aquele que mantém o documento e/ou processo correspondente sob custódia, sendo responsável direto pela sua manutenção.
## ''<u>Estabeleça as matrizes CRUD (Create, Read, Update, and Delete):</u>'' quais indivíduos podem criar, consultar, atualizar o remover os registros associados aos documentos.
### Talvez modelos conhecidos tais como o ''Responsible, Accountable, Consulted, and Informed (RACI)'' sejam úteis e forneçam bases aqui.
## Defina as devidas cadeias de aprovação para a criação e atualização dos documentos e respectivos processos, tais como controles formais de iniciação, revisão e comunicação.
Enfim, o foco deste artigo não é falarmos diretamente sobre BPM e BPMN. Apenas abordei este tema superficialmente para orientá-lo a buscar formas de estabelecer os devidos processos primeiro. Isto é, antes mesmo de você sair documentando a sua rede, defina e gerencie os processos que pautarão esta árdua - porém necessária - missão!

==== Considere a aquisição de uma plataforma de gerenciamento eletrônico de documentos, e com características e funcionalidades de colaboração ====
Isto mesmo! Conforme comentado previamente, é possível termos várias planilhas e vários diagramas devidamente organizados em pastas de um servidor de arquivos de sua empresa. Isto não é exatamente ruim, muito pelo contrário! O problema está na ausência de recursos que fomentem melhor (ou para bem melhor) a conformidade e comunicação destes processos e dos documentos/artefatos associados, sem contar com a manutenção (iniciação, revisão, aprovação, consumo, arquivamento, etc.) dos documentos produzidos.

Você tem duas possibilidades aqui: mantenha tudo em diretórios/pastas bem organizadas na sua rede, ou adote uma solução profissional para gerir isto por você! A escolha é sua.

Aproveitarei a oportunidade, novamente, para citar algumas possibilidades em termos de plataformas neste sentido. Vamos lá?

===== Sistemas com funcionalidades de gerenciamento eletrônico de documentos =====
Com foco nos conceitos de '''''Electronic Document Management System (EDMS)'''''.
* '''Microsoft SharePoint''' (https://products.office.com/pt-br/sharepoint/collaboration)
* '''eFileCabinet''' (https://www.efilecabinet.com/)
* '''Neomind Fusion Platform''' (https://www.neomind.com.br/fusion/site/solutions)
* '''PandaDoc''' (https://www.pandadoc.com/)
* '''Zoho WorkDrive''' (https://www.zoho.com/workdrive/)
* '''Samepage''' (https://www.samepage.io/)
* '''Templafy''' (https://www.templafy.com/)
* '''Source by IC Thrive''' (https://icthrive.com/)
OBS: novamente, você tem a oportunidade de gerenciar todos os documentos da empresa através de plataformas com estas funcionalidades EDMS, e não apenas a parte de documentação de redes!
[[Arquivo:Bpf-doc-4.gif|centro|miniaturadaimagem|900x900px|Gerenciamento eletrônico de documentos (GED): uma necessidade primária de qualquer organização (ex: Microsoft SharePoint)]]

=== Onde os sistemas de GED tradicionais não atendem... ===
Há algumas situações onde você realmente precisará de sistemas ou aplicativos específicos, pois não são recursos nativos destas plataformas orientadas ao GED, além de serem muitos específicos para o planejamento e manutenção das redes de computadores.

==== Gerenciamento de Endereços IP (IPAM) ====
Você indiscutivelmente precisará contar com uma plataforma específica para fins de ''IP Address Management'' ou IPAM. A boa notícia é que em algumas plataformas é possível haver integrações com sistemas de terceiros, e isto significa que há uma chance aqui de desenvolver uma conexão entre o sistema IPAM e outros sistemas da sua organização (ex: CRM, GED, etc.).

A proposta do IPAM é relativamente muito simples, e acho que a maioria dos visitantes aqui da Wiki do BPF compreende isto e provavelmente faz uso de algum sistema deste tipo em sua organização. O IPAM aqui servirá como fonte de referência e controle de alocações e revogações de endereços IP dos blocos do ISP (ou de sua rede corporativa/empresa). Embora em muitos casos seja até viável fazer este tipo de controle usando-se planilhas (pelo menos para o caso do endereçamento IPv4), eu particularmente acho contraproducente e até mesmo inviável para a questão do endereçamento IPv6! Manter alocações IPv6 numa planilha do Excel é "um parto", além de um trabalho bastante amador! Acredite, se ainda não possui um IPAM na sua empresa, você não sabe o que está perdendo!

Há diferenças significativas entre as opções do mercado, em particular funcionalidades e recursos que maximizam a experiência de administração dos endereçamentos IPv4 e IPv6. Fique a vontade para analisar os pros e contras das opções mais conhecidas no mercado:
* '''Infoblox DDI''' (https://www.infoblox.com/products/ddi/)
* '''efficient IP SOLIDserver DDI suite''' (https://www.efficientip.com/products/solidserver/)
* '''Bluecat''' (https://www.bluecatnetworks.com/adaptive-dns/ddi/)
* '''SolarWinds IP Address Manager''' (https://www.solarwinds.com/ip-address-manager?CMP=ORG-BLG-DNS)
* '''ManageEngine IP Address Management (IPAM) Software''' (https://www.manageengine.com/products/oputils/ip-address-manager.html)
* '''LightMesh IPAM''' (https://ipam.lightmesh.com/ipam)
* '''NetBox''' (https://netbox.readthedocs.io/en/stable/)
* '''phpIPAM''' (https://phpipam.net/)
* '''NIPAP''' (http://spritelink.github.io/NIPAP/)
Um dos maiores benefícios do IPAM é permitir o rastreamento de um assinante até o equipamento onde o endereço IPv4 ou IPv6 foi fornecido, bastando informar o endereço ou alguma propriedade relacionada ao assinante. Uma integração entre o IPAM e o CRM é bastante desejável nestes casos visando simplificar a manutenção de todo o contexto.
[[Arquivo:Bpf-doc-3.png|centro|miniaturadaimagem|900x900px|IPAM: uma funcionalidade indispensável para o ISP (ex: phpIPAM)]]

==== Elaboração de diagramas ou topologias ====
Embora muitos sistemas GED possuam sofisticados processadores de textos e documentos, nenhum deles embarca uma funcionalidade específica e adequada para a criação e manutenção de diagramas. Fato! 

No entanto, ao usar os aplicativos específicos para este propósito, você poderá indexar os diagramas (juntamente com metadados e tudo mais) para a plataforma de GED que você escolher adotar para a sua organização, e fazer os vínculos necessários.

Acho que não convém novamente citar os benefícios quanto a utilização de diagramas para a proposta de documentação de redes, certo? Isto está na tabela mostrada anteriormente. Portanto, vejamos algumas das mais conhecidas soluções de mercado, lembrando que há gosto para tudo e que há recursos/funcionalidades melhor disponíveis em algumas destas soluções, se comparado com outras opções. Ou seja, convém você estudar, comparar e constrastar estes pros e contras de cada opção.

Eu particularmente uso dois sistemas o tempo inteiro: ''Microsoft Visio'' e ''Edraw Max.'' E, em alguns casos, o ''Monodraw,'' para diagramas "texto" no corpo dos emails, quando preciso "desenhar para explicar" algo rapidamente. 
* '''Microsoft Visio Professional''' (https://www.microsoft.com/pt-br/p/visio-professional-2019/cfq7ttc0k7cg?activetab=pivot%3aoverviewtab)
* '''Edraw Max''' (https://www.edrawsoft.com/)
* '''Lucidchart''' (https://www.lucidchart.com/pages/pt)
* '''OmniGraffle''' (https://www.omnigroup.com/omnigraffle/)
* '''Dia Diagram Editor''' (http://dia-installer.de/index.html.en)
* '''SmartDraw''' (https://www.smartdraw.com/)
* '''Monodraw''' (https://monodraw.helftone.com/)
* '''Creately''' (https://creately.com/)
* '''Draw.io''' (https://www.draw.io/)
* '''yEd Grap''' (https://www.yworks.com/products/yed)
* '''Gliffy''' (https://www.gliffy.com/)
* '''LibreOffice Draw''' (https://www.libreoffice.org/discover/draw/)
* '''Apache OpenOffice Draw''' (http://www.openoffice.org/product/draw.html)
* '''ThinkComposer''' (http://www.thinkcomposer.com/)
* '''Grafio''' (http://tentouchapps.com/grafio/)
* '''Diagramo''' (http://diagramo.com/)
* '''Mydraw''' (https://www.mydraw.com/)
[[Arquivo:Bpf-doc-5.png|centro|miniaturadaimagem|900x900px|Mantenha os diagramas da sua rede em dia, pois são muito úteis! (ex: Edraw Max)]]
Uma das maiores vantagens do Microsoft Visio é a quantidade quase que ilimitada de ''stencis'' disponíveis! Praticamente todo o fabricante de soluções de TI possui ''stencils'' prontos/compatíveis com o Microsoft Visio! Confira alguns dos repositórios que contém estes ''stencils'':
* '''Cisco Visio Stencils''' (https://www.cisco.com/c/en/us/products/visio-stencil-listing.html)
* '''Cisco Network Topology Icons''' (https://www.cisco.com/c/en/us/about/brand-center/network-topology-icons.html)
* '''Juniper Product Icons & Visio Stencils''' (https://www.juniper.net/us/en/products-services/icons-stencils/)
* '''Huawei Product Image Gallery''' (https://support.huawei.com/onlinetoolweb/Network_imagelib/index?domain=0&lang=en)
* '''Mikrotik Rack-mounted Devices Visio Stencils''' (https://forum.mikrotik.com/viewtopic.php?t=120957)
Há também os ''stencils'' "livres", produzidos às centenas. Confira alguns destes repositórios a seguir:
* '''VisioCafe''' (http://www.visiocafe.com/)
* '''Shape Source''' (https://www.shapesource.com/)
* '''Graffletopia''' (https://www.graffletopia.com/categories/network)
* '''3D Networking''' (https://3d-networking.com/3d-symbols/)
[[Arquivo:Bpf-doc-6.jpg|centro|miniaturadaimagem|900x900px|Stencils para Microsoft Visio]]

===== Elaboração dinâmica de diagramas ou topologias =====
O "problema" da diagramação usando Visio, Edraw e outros é um só: você precisa inspecionar toda a sua rede para confirmar como as conexões físicas e lógicas são feitas, ou seja, acessar os equipamentos, um por um, consultar as configurações e estados operacionais associados às interfaces, VLANs, ARP cache, tabela MAC, protocolos de resiliência L2, adjacências de protocolos de roteamento, tabela de roteamento (rotas), vizinhanças MPLS, vizinhanças de LLDP ou CDP, etc. Um processo absolutamente manual e que consome muito tempo - sem contar que pode provocar inconsistências ("''error-prone''"). O resultado será um só: <u>diagramas estáticos</u>. Cada mudança na rede exigirá uma modificação inteiramente manual nos documentos referentes aos componentes e propriedades que foram modificados.

Uma alternativa mais ousada aqui seria com uma solução que ao menos fizesse a maior parte deste mega-esforço que normalmente você teria ao diagramar uma rede grande e/ou complexa! Fornecerei algumas sugestões logo abaixo:
* '''NetBrain''' (https://www.netbraintech.com/network-diagram-software/)
* '''SolarWinds Network Topology Mapper''' (https://www.solarwinds.com/pt/network-topology-mapper)
* '''Cisco Crosswork Network Automation''' (https://www.cisco.com/c/en/us/products/cloud-systems-management/crosswork-network-automation/index.html)
Parece maravilhoso, certo? No entanto, há diversos desafios e complexidades aqui. Obviamente convém um estudo bem racional sobre os recursos e funcionalidades destas soluções para você entender algumas coisas:
# Fornecem as funcionalidades requeridas para a manutenção/operação de minha infraestrutura?
# Os meus equipamentos (hardware + software) são plenamente compatíveis com estas soluções?
# Além da manutenção dinâmica das topologias, quais benefícios a solução trará para o meu negócio?
# É possível quantificar o retorno sobre o investimento (ROI) com a aquisição de uma solução destas?
[[Arquivo:Netbrain.png|centro|miniaturadaimagem|900x900px|Diagramas dinâmicos da rede: uma realidade! (ex: NetBrain)]]

==== Base de conhecimento ("Knowledge Base") ====
Eu particularmente vejo isto como uma mão na roda em qualquer ambiente de redes, seja ISP ou corporativo. Algumas das sugestões de sistemas indicados neste artigo embarcam funcionalidades deste tipo. No entanto, possa ser que não atendam às expectativas da organização e que, por conta disto, você tenha que buscar soluções específicas do mercado. Algumas sugestões a seguir:
* '''MediaWiki''' (https://www.mediawiki.org/wiki/Download/pt-br)
* '''Nuclino''' (https://www.nuclino.com/)
* '''PHPKB''' (https://www.knowledgebase-script.com/)
* '''Document360''' (https://document360.io/)
* '''Tribe''' (https://tribe.so/)
* '''Galisto''' (https://en.galisto.ch/)
* '''Zoho Desk''' (https://www.zoho.com/desk/)
* '''ManageEngine Service Desk Plus''' (https://www.manageengine.com/products/service-desk/?ITSMAds)
* '''Jive Software''' (https://www.jivesoftware.com/product/)
* '''Bitrix24''' (https://www.bitrix24.com.br/)
* '''Jira Software''' (https://www.atlassian.com/software/jira)
* '''Confluence''' (https://www.atlassian.com/software/confluence)
* '''ActiveCollab''' (https://activecollab.com/)
* '''SysAid''' (https://www.sysaid.com/)
[[Arquivo:Bpf-doc-7a.jpg|centro|miniaturadaimagem|900x900px|Base de conhecimento: conectando pessoas e disseminando valores (ex: PHPKB)]]

==== Documentação da planta FTTH ====
Todos os ISPs precisam de softwares específicos para a documentação e gerenciamento da rede FTTH! Os detalhamentos destas necessidades serão discutidos em futuros artigos aqui na Wiki do BPF, possivelmente contando com a colaboração de fornecedores destas soluções nestes artigos para melhor aproveitamento e experiência de nossos leitores. Confira algumas das soluções conhecidas utilizadas por ISPs brasileiros para a documentação de suas redes FTTH:
* '''OZmap''' (https://ozmap.com.br)
* '''Geosite Telecom''' (https://digicade.com.br/produtos/geosite-telecom/)
* '''Topmaps''' (https://topsapp.com.br/topmaps)
* '''GeoGrid Maps''' (https://geogridmaps.com.br/)
* '''Optnet''' (https://www.optnet.com.br/Principal.aspx)
* '''Bentley Fiber''' (https://www.bentley.com/pt/products/product-line/utilities-and-communications-networks-software/bentley-fiber)
* '''Vigo''' (https://www.vigo.com.br/artigo/documentacao-da-rede-ftth-sem-integracao)
* '''MK Netmaps''' (http://www.mknetmaps.com.br/)
* '''QGIS''' (https://www.qgis.org/pt_BR/site/about/case_studies/poland_ffth.html)
* '''GIIRO''' (https://giiromaps.com.br/)
[[Arquivo:Bpf-doc-ftth1.png|centro|miniaturadaimagem|900x900px|A documentação de uma rede FTTH (ex: GeoGrid Maps)]]

=== Resumo de boas práticas para a documentação de sua rede ===
Que tal juntarmos todos os passos de forma mais educativa? 
# Planeje os tipos de artefatos (documentos) necessários para o seu negócio.
# Associe cada artefato para metas tangíveis do negócio (justificativa, expectativas, objetivos, resultados almejados).
# Defina a qualidade de detalhes que cada artefato deverá possuir.
# Elabore o aspecto estrutural de cada artefato (seções, corpo, tabelas, gráficos, estruturas necessárias, etc.).
# Defina o processo de iniciação, revisão, comunicação, e conformidade de cada artefato.
# Defina os "''roles''" (CRUD) de cada processo e artefato.
# Defina a classificação (grau de confidencialidade) de cada artefato.
# Defina as tecnologias que viabilizarão a construção e manutenção dos artefatos (será por planilhas/Excel documentos/Word, diagramas/Visio/etc., com ou sem uma plataforma de GED? Com ou sem KB?).
# Audite a utilização dos artefatos, certificando-se que ações na rede (configurações e suporte) não fluam fora dos escopos e métodos aprovados pela organização, regidos por estes documentos e processos.
# Revisite a eficácia dos seus artefatos e respectivos processos, refinando-os até que atinjam o grau de êxito e maturidade esperado para cada objetivo/expectativa/resultado almejado (são úteis? dão conta? são aderentes?)
# Certifique-se que quaisquer ações na rede sejam refletidas nos documentos e vice-versa. OK, isto permeia um tanto a parte de GMUD - o qual não é o foco do artigo. Fica para a próxima.
## '''<u>Não</u>''' permita que a sua documentação fique defasada com relação ao estado operacional da sua rede!

=== Conclusão do artigo ===
Neste artigo procurei fornecer os conhecimentos necessários para que você pudesse - em primeiro momento - compreender a importância das ações de documentação de sua infraestrutura. Entendo que o roteiro comentado aqui é adequado, pois disseminei algumas áreas de interesses e sugestões para você poder iniciar o seu planejamento sobre como uma boa documentação da rede pode ser concebida para o seu negócio.

Futuros artigos a serem publicados aqui na Wiki do BPF serão mais específicos e objetivos, onde espero contribuir com casos mais práticos sobre o tema.

Até lá!

'''Autor: [https://wiki.brasilpeeringforum.org/w/Usu%C3%A1rio:Leonardo.furtado Leonardo Furtado]'''
[[Categoria:BCOPs]]
[[Categoria:Capacitação]]