Documentação Digital: Melhores Práticas para Informar e Inspirar
Product Documentation Best Practices

Digital Documentation: Best Practices to Inform and Inspire

Tal F

Tal F

May 04, 2021

Para impulsionar a facilidade e consistência, as empresas devem seguir as melhores práticas de documentação digital. Isto abrange o design, a formatação, a escolha de tipos de ficheiros e a governação da documentação digital.


Share this article:

Do Papel para os Pixels

Há apenas algumas décadas, quase todas as empresas usavam papel para documentação. Contratos, políticas, notas de reuniões; tudo era baseado em papel - sendo impresso e passado de mão em mão em vez de anexado e analisado por email.

Com o avanço da tecnologia, as empresas passaram a ter mais espaço de armazenamento para documentação e sistemas informáticos que permitem aos funcionários aceder a estes documentos digitais. Este é o início da transição do papel para os pixels.

O mundo moderno da documentação digital oferece inúmeras vantagens, mas persistem alguns problemas. A documentação serve para transmitir informação, tanto aos funcionários internos como aos clientes externos. Por isso, a consistência do conteúdo, a facilidade de acesso e a gestão simplificada são essenciais. Pelo contrário, documentação digital inconsistente, inacessível e de difícil gestão pode reduzir a capacidade da sua empresa de transmitir informação de forma eficaz.

Para garantir facilidade e consistência, as empresas devem seguir as melhores práticas de documentação digital. Isto inclui o design, a formatação, a escolha dos tipos de ficheiros e a governança da documentação digital.

Neste eBook, discutiremos as melhores práticas para documentação digital e o potencial impacto empresarial destas mudanças. Será que uma melhor documentação digital pode impulsionar o crescimento de receitas e atrair clientes? Como podem as empresas transformar a sua documentação digital para oferecer mais valor aos clientes através de um sistema de gestão documental (DMS)?

Vamos responder a estas questões!

Benefícios da Documentação Digital

Antes de discutirmos o quê e o como das melhores práticas de documentação digital, devemos primeiro compreender os seus benefícios:

  • Facilidade de Gestão -- A documentação digital é mais fácil de gerir do que documentos em papel. A documentação em papel requer espaço no escritório para um arquivo, e exige arquivamento manual para cada documento. O armazenamento digital liberta espaço no escritório e simplifica a gestão com funcionalidades de pesquisa e estruturas de pastas.

Como detalhado neste estudo da Software Advice, os trabalhadores de escritório gastam em média seis horas por semana a procurar documentos em papel. Além disso, gastam em média oito horas por semana a criar relatórios a partir de documentos em papel, com 94% a afirmar que um sistema de gestão documental (DMS) facilita este processo.[1]

  • Facilidade de Acesso - Estes documentos digitais podem ser partilhados, praticamente em tempo real, por email ou armazenamento na cloud. Isto elimina a necessidade de enviar cartas, eliminando custos de portes ou estafetas. Também aumenta a velocidade de resposta, pois os destinatários já não precisam de esperar dias para receber uma carta. Além disso, a documentação digital pode ser disponibilizada no seu site ou redes sociais, melhorando a facilidade de acesso para os clientes.

Sabia que - segundo a Gartner - por cada 1€ gasto na impressão de documentos, são gastos mais 6€ no manuseamento e distribuição desses documentos? Além disso, metade de todos os documentos impressos são deitados fora em menos de 24 horas.[2]

  • Segurança e Governança -- A menos que esteja guardada à chave, a documentação em papel é insegura. Qualquer pessoa pode lê-la, fazer uma cópia e partilhá-la como entender. Pelo contrário, a documentação digital pode ser governada por controlos de acesso baseados em funções (RBAC) para conceder acesso apenas a quem precisa.

Nem mesmo os Governos estão imunes a violações de dados em papel, com o Departamento de Assuntos de Veteranos dos EUA a atribuir à documentação em papel a razão de 98% das violações de dados[3].

  • Benefícios Ambientais -- Pessoas e empresas procuram formas de reduzir a sua pegada ambiental. A documentação digital é uma dessas vias. Segundo a Green America, o consumo de papel aumentou 400% nos últimos 40 anos, com a indústria a representar 4% do consumo global de energia[4]. Ao optar pela documentação digital, as empresas podem reduzir o uso de papel para combater a desflorestação -- mantendo as árvores vivas para absorver emissões de carbono e sustentar habitats animais.

Melhores Práticas Com Documentação Digital no Docsie

A documentação digital tem o potencial de transformar a partilha de conhecimento, a publicação e o marketing em toda a empresa. Para aproveitar este potencial, as empresas devem seguir as melhores práticas de documentação digital:

Alinhe o Seu DMS Com as Necessidades da Empresa

Um sistema de gestão documental (DMS) é a base que ajuda as empresas a armazenar e gerir a sua documentação. Depois de o conteúdo ser escrito, é carregado para um DMS para armazenamento e distribuição. Um DMS centraliza o armazenamento de documentação, fornecendo uma única fonte de conhecimento para toda a empresa. Funciona como uma biblioteca digital, categorizando documentos por departamento ou produto, com funcionalidades de pesquisa para agilizar a partilha de conhecimento. A partir daqui, as equipas de marketing e suporte podem partilhar documentação, publicando-a em sites e redes sociais, ou em resposta a questões dos clientes.

O Docsie é um DMS que simplifica a forma como a sua equipa trabalha com documentos. Cada empresa precisa de uma forma de armazenar e partilhar documentação, tanto para que os funcionários internos possam aprender sobre as suas funções, como para que os clientes possam aprender a usar o seu produto ou serviço. Documentos de integração de RH, guias de utilização de produtos, modelos de comunicação de vendas — todos estes elementos podem ser armazenados e publicados com a solução DMS adequada.

Que documentação existe atualmente sobre os seus produtos e serviços? Os seus funcionários usam modelos e estruturas ao comunicar com os clientes? Consegue armazenar, partilhar internamente e publicar externamente a sua documentação com facilidade? Faça estas perguntas ao considerar uma solução DMS como o Docsie, e certifique-se de que o seu DMS está alinhado com as necessidades da empresa.

Foque-se na Compatibilidade

A documentação digital pode aumentar a acessibilidade, mas apenas quando utiliza formatos de ficheiros altamente compatíveis. Isto é importante com documentação descarregável, pois alguns clientes podem não conseguir abrir um ficheiro. Também se aplica à documentação interna, onde um funcionário que usa PDF e outro que usa DOCX pode causar fragmentação de formatos de ficheiros -- levando outros funcionários a mudar de pacotes de software ou a converter para outro formato para tornar o ficheiro acessível.

Formatos de ficheiros abertos como docx, xlsx e pptx para Microsoft Office, ou o formato de documento aberto (ODF) para OpenOffice são ideais para maximizar a compatibilidade. Os documentos Adobe PDF são comuns, mas menos compatíveis por exigirem um visualizador de PDF. Considere quem irá aceder a estes documentos e armazene a documentação num formato que atenda à mais ampla base de utilizadores possível.

O Docsie é uma ótima opção para ampla compatibilidade de documentos. Quando o texto é carregado no Editor de Livros Docsie, é armazenado no formato de ficheiro JavaScript Object Notation (JSON) de código aberto. Pode encontrar mais informações sobre exportação de documentos e como o Docsie permite a conversão fácil para formatos DOC, PDF, Markdown (MD) e HTML aqui.

Feedback Acionável

O feedback de utilizadores e funcionários sobre a documentação é vital. Se a documentação carece de informações, contém informações incorretas ou é simplesmente difícil de ler -- os leitores terão dificuldade em obter valor da sua documentação. Além disso, o feedback pode ajudar a melhorar a documentação existente para fornecer mais valor aos clientes, impulsionando o sucesso empresarial através da partilha de conhecimento de qualidade.

O Docsie Vocally é um serviço completo de monitorização e resposta a feedback. Permite que os leitores classifiquem peças individuais de documentação numa escala de um a cinco, com comentários para explicar as razões da sua classificação. Os Proprietários e Administradores do Docsie podem ler este feedback, obtendo informações sobre o sucesso e as deficiências da sua documentação.

As bases de conhecimento self-service são projetadas para minimizar os requisitos de suporte, mas isso também significa que os clientes provavelmente não persistirão com documentação inadequada -- em vez disso, procurarão uma alternativa com concorrentes que forneçam melhor documentação. Para resolver este problema, o Docise Vocally registará as interações dos utilizadores enquanto leem a sua documentação. Isto destacará onde encontraram um problema num documento e qual conteúdo está a causar o problema. Os redatores podem usar este feedback para editar a documentação e agir com base no feedback dos utilizadores. Com o tempo, isso melhorará a qualidade do conhecimento na documentação, capacitando os clientes a ajudarem-se a si próprios.

A capacitação do cliente é uma ótima maneira de atrair novos negócios, reduzir custos e reter clientes. Cerca de 67% dos clientes preferem o self-service a falar ao telefone, de acordo com a Zendesk[5]. A Forrester Research e a Oracle também descobriram que o self-service pode reduzir os custos de suporte em 11€ por chamada[6]. Por fim, um estudo da Microsoft destaca como 90% dos clientes esperam uma opção de self-service[7].

Em resumo, os clientes preferem e esperam um self-service de qualidade, e fornecer esta opção pode reduzir significativamente os custos de suporte. Ao criar uma base de conhecimento self-service no Docsie e melhorar a qualidade da documentação com feedback através do Docsie Vocally, pode atender às exigências em evolução dos clientes através da documentação digital. Leia mais sobre o Docsie Vocally aqui.

Versionamento de Documentos

Particularmente em empresas de tecnologia, novas versões de software ou serviços podem introduzir problemas com documentação. A nova versão pode incluir fluxos de trabalho diferentes das versões anteriores ou terminologia diferente que pode confundir os utilizadores. Ao mesmo tempo, a nova documentação pode não se aplicar a versões mais antigas dos seus serviços, criando lacunas de conhecimento que têm o potencial de frustrar e afastar clientes.

Esta é uma prática importante com documentação digital. Os clientes podem precisar de versões mais antigas do seu software por questões de compatibilidade com o hardware deles, ou simplesmente optar por não atualizar para uma nova versão. Assim, as empresas devem sempre atender à sua base de utilizadores, independentemente da versão que estão a usar.

O Docsie resolve este problema com o versionamento de documentos. Quando atualiza um documento no Docsie, pode manter versões anteriores para fins de redundância. Os clientes na versão 2 do seu serviço podem selecionar a documentação correta, enquanto os clientes na versão 1 ainda têm acesso à documentação mais antiga. Isto chama-se fragmentação; quando a sua base de clientes está dividida entre múltiplas versões do mesmo software. O Docsie reduz o impacto da fragmentação, garantindo que o conhecimento está disponível independentemente da versão em uso.

O versionamento de documentos garante que as informações corretas estão disponíveis quando necessário. Também ajuda na rastreabilidade, especialmente quando vários redatores estão a trabalhar na mesma peça de conteúdo. O versionamento também reduz a duplicação, consolidando a sua documentação para facilitar o acesso.

A sua empresa atualiza regularmente a sua documentação? Os seus clientes estão a ter dificuldade em encontrar as informações corretas para versões atuais e históricas do seu software e serviços? Se sim, pode ser hora de aplicar a melhor prática de versionamento de documentos através de um DMS como o Docsie. Pode encontrar mais informações sobre o versionamento de documentos do Docise aqui.

Hábitos de Documentação da Força de Trabalho

As suas pessoas criam documentação, mas também podem criar problemas com ela. Durante a fase de rascunho, os redatores podem usar diferentes tamanhos ou tipos de fonte, ou iconografia e arte desatualizadas. Estas diferenças são fáceis de passar despercebidas para funcionários que trabalham com conteúdo todos os dias, mas os clientes têm mais probabilidade de notar. O resultado é documentação inconsistente, impulsionada por inconsistências na abordagem à criação e publicação de conteúdo em toda a sua força de trabalho.

O Docsie ajuda as empresas a enfrentar a inconsistência de conteúdo com o Hub de Documentação Docsie. Pode definir um tipo e tamanho de fonte padrão, adicionar logótipos ou arte da empresa e definir parâmetros de folha de estilo CSS para uso num site da empresa ou base de conhecimento. Estas escolhas propagam-se do Docsie para qualquer página web com conteúdo incorporado do Docsie, usando as mesmas cores, fontes e logótipos em todos os locais onde o seu conteúdo é publicado.

Isto simplifica os fluxos de trabalho de gestão e publicação de conteúdo. Em vez de editar páginas individuais, as empresas podem definir uma estrutura de design de conteúdo uma vez no Docsie e aplicar essas alterações em todos os lugares. Isto é conhecido como gestão centralizada ou orquestração. O processo de editar cada documento ou página individualmente pode parecer viável para bibliotecas de conteúdo menores, mas este processo não será eficiente à medida que a biblioteca cresce em amplitude e profundidade.

Em resumo, o Docsie trabalha para preparar os seus fluxos de trabalho de gestão de conteúdo para o futuro, minimizando as cargas de trabalho administrativas de baixo nível. Começando com a escala em mente, grandes bibliotecas de conteúdo podem ser geridas com simplicidade - definindo estruturas de design de conteúdo uma vez e implementando em todos os lugares com o Docsie. Pode descobrir mais sobre os Hubs de Documentação Personalizados do Docsie usando o Docsie Manager aqui.

Armazenamento Centralizado de Documentação

Sobre o tema da centralização, os locais de armazenamento de documentos podem ajudar ou dificultar os fluxos de trabalho de gestão e publicação. Pode armazenar documentação numa intranet ou site SharePoint, no Dropbox ou Google Drive, e em partições de armazenamento local ou na cloud. Cada opção funciona isoladamente, mas pode causar caos quando usadas simultaneamente.

Um funcionário precisa de acesso a um documento. O documento está armazenado num site SharePoint. O funcionário descarrega-o e guarda-o na sua partição de armazenamento de conta. Uma ferramenta de sincronização de ficheiros empresariais carrega isto para a cloud automaticamente. O funcionário envia o documento via Slack para um colega. São quatro cópias do mesmo documento em circulação na sua rede de TI, com descentralização em quatro serviços ou ferramentas diferentes.

O Docsie resolve este caos descentralizado centralizando documentos num único local de armazenamento. Quando carrega um documento, o Docsie coloca-o numa prateleira. Referimo-nos a documentos como livros, com cada prateleira a encher-se de livros para formar uma biblioteca de conteúdo. Os funcionários podem iniciar sessão no Docsie para encontrar toda a sua documentação, com filtragem que entrega documentação relevante por departamento ou antiguidade usando controlos de acesso baseados em funções (RBAC). A partir daqui, os funcionários podem publicar documentos diretamente no seu site, editar texto de documentação, verificar diferentes versões e ver feedback de clientes ou colegas.

Agora, quando um funcionário precisa de acesso a um documento, tudo o que tem de fazer é abrir o Docsie. Pode pesquisar documentos, exportar em formatos de ficheiros comuns e partilhar links diretos para livros ou prateleiras do Docsie. Para utilizadores externos, podem ser convidados por Proprietários e Administradores para acesso direto a livros e prateleiras do Docsie autorizados, sem comprometer a segurança. É como pastas e ficheiros num disco rígido, mas com um pouco de magia Docsie! Pode descobrir mais sobre prateleiras e livros Docsie aqui.

Risco de Governança e Conformidade de Documentos

A maioria da documentação será criada para o domínio público. Ainda assim, alguma documentação pode ser confidencial. Isto apresenta a necessidade de gestão de governança, risco e conformidade (GRC). As políticas de GRC podem ser usadas para governar o acesso a documentos confidenciais, controlar permissões de documentos para redatores e leitores, e prevenir a publicação acidental de documentação na fase de rascunho.

O Docsie usa controlos de acesso baseados em funções (RBAC) para governar permissões na plataforma. É assim que o Docsie ajuda as empresas a gerir fluxos de trabalho de GRC, definindo funções de utilizador e atribuindo permissões com base na antiguidade ou departamento. Estas funções incluem Visualizador, Editor, Administrador e Proprietário. Os Visualizadores têm acesso de apenas leitura aos documentos, enquanto os editores têm permissões de leitura e escrita. Os Administradores podem atribuir funções para gerir quem tem permissão para ler, escrever ou ambos por livro ou por prateleira. O Proprietário pode gerir cada utilizador e documento numa organização Docsie, e é a única função de utilizador que pode eliminar uma organização inteira. Neste exemplo, a organização poderia ser o Docsie, com prateleiras contendo livros sobre diferentes funcionalidades no Docsie.

Em conclusão, o GRC é importante para gerir o acesso à documentação. Com pouco acesso, os funcionários não poderão trabalhar na documentação. Com demasiado acesso, os funcionários podem publicar acidentalmente documentação inacabada ou ganhar acesso a documentos confidenciais reservados para executivos e gestores. O Docsie ajuda-o a encontrar um equilíbrio entre acesso e segurança, tornando a plataforma adequada para armazenar qualquer tipo de documento.

Este documento é sensível, como posso impedir o acesso não autorizado? Como posso dar à minha equipa permissões de escrita, enquanto só dou a outras equipas acesso de leitura? Um redator freelancer precisa de permissão para editar este documento, como posso fazê-lo? Se a sua empresa está a fazer estas perguntas, o Docsie tem as respostas! Pode encontrar mais informações sobre a gestão de permissões do Docsie aqui.

Colaboração em Equipa

O conteúdo raramente é criado por uma única pessoa. Quando vários redatores estão a trabalhar na sua biblioteca de documentação, a colaboração é crítica.

Que processos seguem os seus funcionários quando trabalham na documentação? Um exemplo seria pesquisar numa unidade de rede documentos existentes e descarregá-los para um computador. Em seguida, o redator pode enviar um rascunho final por email a um colega para mais revisão. O rascunho aprovado pode então ser carregado para um sistema de gestão de conteúdo (CMS) pronto para publicação. Mais tarde no dia, alguém nota um problema e envia uma versão anotada de volta ao redator via Slack. Este fluxo de trabalho pode funcionar, mas pode ser simplificado.

O Docsie reduz o número de ferramentas necessárias com funcionalidades abrangentes de colaboração em equipa. Pode encontrar documentos no Docsie, escrever e editar, partilhar alterações com membros da equipa, conversar e anotar, e publicar na internet sem nunca sair do painel do Docsie. Isto elimina a necessidade de descarregar, carregar, enviar emails e gerir um CMS -- permitindo-lhe simplesmente gerir os seus documentos com o Docsie! Os membros da equipa podem ser marcados usando @menção, as conversas de chat são isoladas para cada livro Docsie, e freelancers externos podem ser convidados com facilidade para colaboração completa em equipa em qualquer local.

Ao minimizar o número de ferramentas necessárias, os funcionários podem concentrar-se na criação de conteúdo em vez de alternar entre software. Isto acelera os fluxos de trabalho de criação de conteúdo, minimizando cliques desperdiçados, com comentários e sugestões de colegas facilmente acessíveis na barra de ferramentas à direita. Não mais partilha de links, não mais versões desatualizadas de documentos, não mais emails ou mensagens de chat perdidos -- tudo relacionado com os seus documentos está centralizado no Docsie.

Aplique as Melhores Práticas aos Seus Documentos Com o Docsie

À medida que passamos do papel para os pixels, a boa gestão de documentação é vital. Ao aplicar estas melhores práticas à documentação digital, as empresas podem criar e partilhar conhecimento que oferece valor real aos clientes, ao mesmo tempo que agiliza os fluxos de trabalho de conteúdo e reduz custos. A única questão é -- como aplicar estas melhores práticas?

É aqui que entra o Docsie. O Docsie baseia-se nestas melhores práticas de documentação, aplicando-as automaticamente para agilizar a criação, gestão e publicação de conteúdo. A plataforma foi concebida para trabalhar com todos os tipos de documentação, alinhando-se de perto com os requisitos típicos de DMS empresarial. Durante a importação e exportação, a documentação Docsie usa formatos de ficheiros abertos e compatíveis para aumentar a acessibilidade. As empresas podem ler e agir sobre o feedback de documentação de clientes usando o Docsie Vocally, melhorando a qualidade do conhecimento e reduzindo erros de conteúdo. O versionamento de documentos permite-lhe manter versões históricas para redundância de informação. A marca e as estruturas de design de conteúdo podem ser definidas uma vez e aplicadas em toda parte com o Hub de Documentação Personalizado. Tudo é armazenado num local -- o Portal Docsie -- para que os funcionários possam encontrar rapidamente um documento em vez de pesquisar no computador, na cloud ou no email. As permissões podem ser definidas para gerir GRC, impedindo o acesso não autorizado a documentos sensíveis. Finalmente, os colegas podem conversar, partilhar, ligar, anexar e conceder acesso a contratados para colaboração centralizada em equipa no Docsie.

Crie documentação que os seus clientes vão adorar, sem a complexidade. Se a sua empresa está à procura de uma solução DMS, considere experimentar o Docsie! Basta entrar em contacto com a nossa equipa de vendas, que terá todo o gosto em guiá-lo através de uma demonstração de 15 minutos da plataforma Docsie.


[1] <https://www.softwareadvice.com/cms/industryview/go-paperless-with-document-management-software/>

[2] <https://www.stopwaste.org/at-work/reduce-and-reuse/reduce-paper-use/the-impact-of-paper-waste#2>

[3] <https://fcw.com/articles/2013/08/08/va-data-breaches.aspx>

[4] <https://www.greenamerica.org/sites/default/files/inline-files/Paper%20Facts%202017.pdf>

[5] <https://www.zendesk.com/blog/searching-for-self-service/>

[6] <https://www.slideshare.net/UniWeb/the-total-economic-impact-of-click-to-call-and-click-to-chat>

[7] <https://download.microsoft.com/documents/en-us/dynamics/Global_State_of_Multichannel_Customer_Service_Report.pdf.pdf>

Related Articles

Ready to Transform Your Documentation?

Discover how Docsie's powerful platform can streamline your content workflow. Book a personalized demo today!

Book Your Free Demo
4.8 Stars (100+ Reviews)
Tal F

Tal F

VP of Customer Success @ Docsie