Documentação digital: Melhores práticas para informar e inspirar

Avatar of Author
Tal F
on May 04, 2021 · · filed under Product Documentation Best Practices

Do Papel aos Pixels*

Há apenas algumas décadas, parecia que todas as empresas utilizavam papel para a documentação. Contratos, políticas, notas de reunião; tudo era baseado em papel - sendo impresso e transmitido em vez de anexado e analisado via correio electrónico.

À medida que a tecnologia se foi tornando mais avançada, as empresas tinham mais espaço de armazenamento para documentação, e os sistemas informáticos necessários para que os empregados pudessem aceder a estes documentos digitais. Isto marca o início de uma transição do papel para os pixels.

O mundo moderno da documentação digital oferece inúmeros benefícios, mas os problemas persistem. A documentação é utilizada para transmitir informação, tanto ao pessoal interno como aos clientes externos. Isto significa que a consistência do conteúdo, a facilidade de acesso, e a facilidade de gestão são essenciais. Ao contrário, documentação digital inconsistente, inacessível e incontrolável pode reduzir a sua capacidade empresarial de transmitir informação de forma eficaz.

Para facilitar e manter a coerência, as empresas devem seguir as melhores práticas em matéria de documentação digital. Isto engloba a concepção, formatação, escolha dos tipos de ficheiros, e gestão da documentação digital.

Neste livro electrónico, discutiremos as melhores práticas para a documentação digital e o potencial impacto comercial da realização destas mudanças. Pode uma melhor documentação digital impulsionar o crescimento das receitas e atrair clientes? Como é que as empresas podem transformar a sua documentação digital para oferecer melhor valor aos clientes utilizando um sistema de gestão de documentação, ou DMS?

Vamos responder a estas perguntas!

Benefícios da Documentação Digital

Antes de discutirmos o quê e como da documentação digital, devemos primeiro compreender as vantagens da documentação digital:

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

Tal como detalhado neste estudo do Software Advice, os trabalhadores de escritório passam em média seis horas por semana à procura de documentos em papel. Além disso, os trabalhadores de escritório passam uma média de oito horas por semana a criar relatórios a partir de documentos em papel, com 94% a dizer que um sistema de gestão de documentos (DMS) torna este processo mais fácil.[1]

  • Facilidade de acesso** - Estes documentos digitais também podem ser partilhados, virtualmente em tempo real, através de correio electrónico ou armazenamento em nuvem. Isto nega a necessidade de envio de cartas, eliminando os custos de envio ou de correio. Também aumenta a velocidade de resposta, uma vez que os destinatários já não precisam de esperar dias para que uma carta chegue. Além disso, a documentação digital pode ser implantada no seu website ou nas redes sociais, melhorando a facilidade de acesso para os clientes.

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

  • Segurança e Governação -- A menos que esteja escondida atrás de uma fechadura e chave, a documentação em papel é insegura. Qualquer pessoa pode lê-la, fazer uma cópia, e partilhar como achar melhor. Ao contrário, a documentação digital pode ser governada por controlos de acesso baseados em papéis (RBAC) para conceder acesso apenas àqueles que dele necessitem.

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

  • Benefícios ambientais* -- Tanto as pessoas como as empresas estão à procura de formas de reduzir a sua pegada ambiental. A documentação digital é uma via que podem seguir. 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 optarem pela documentação digital, as empresas podem reduzir a sua utilização de papel para combater a desflorestação -- mantendo as árvores vivas para absorver as emissões de carbono e sustentar os habitats animais.

Melhores-práticas com documentação digital em Docsie*

A documentação digital tem a capacidade de transformar a partilha de conhecimentos, a publicação e o marketing em toda a empresa. Para explorar este potencial, as empresas devem seguir as melhores práticas em matéria de documentação digital:

Alinhe o seu DMS com as necessidades do negócio

Um sistema de gestão documental (DMS) é a base que ajuda as empresas a armazenar e gerir a sua documentação. Depois de escrito, o conteúdo é carregado para um DMS para armazenamento e distribuição. Um DMS centraliza o armazenamento da documentação, fornecendo uma única fonte de conhecimento para toda a empresa. Isto funciona muito como uma biblioteca digital, categorizando documentos por departamento ou produto, com funcionalidade de pesquisa para racionalizar a partilha de conhecimento. A partir daqui, as equipas de marketing e apoio podem partilhar documentação, publicando-a em websites e meios de comunicação social, ou em resposta a consultas de clientes.

Docsie é um DMS que simplifica a forma como a sua equipa faz docs. Cada empresa precisa de uma forma de armazenar e partilhar documentação, tanto para que o pessoal interno possa aprender sobre o seu papel no trabalho, como para que os clientes possam aprender a utilizar o seu produto ou serviço. Documentos de HR onboarding, guias de produtos, modelos de comunicação de vendas - todos estes itens podem ser armazenados e publicados com a solução DMS correcta.

Que documentação existe actualmente sobre os seus produtos e serviços? O seu pessoal utiliza modelos e estruturas quando comunica com os clientes? Pode facilmente armazenar, partilhar internamente, e publicar externamente a sua documentação? Faça estas perguntas ao considerar uma solução DMS como Docsie, e assegure-se de que a sua DMS está alinhada com as necessidades comerciais.

Foco na Compatibilidade

A documentação digital pode aumentar a acessibilidade, mas apenas quando se utilizam formatos de ficheiro altamente compatíveis. Isto é importante com a documentação descarregável, uma vez que certos 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 do formato do ficheiro -- levando outros funcionários a mudar de pacote de software, ou a converter para outro formato para tornar o ficheiro acessível.

Os formatos de ficheiro 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 devido à necessidade de um visualizador de PDF. Considere quem terá acesso a estes documentos, e armazene a documentação num formato que atenda a uma base de utilizadores o mais ampla possível.

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

Feedback accionável

O feedback dos utilizadores e funcionários sobre a documentação é vital. Se a documentação carece de informação, contém informação incorrecta, ou é simplesmente difícil de ler -- os leitores terão dificuldade em obter qualquer valor da sua documentação. Além disso, o feedback pode ajudar a melhorar a documentação existente para fornecer mais valor aos clientes, conduzindo o sucesso do negócio através da partilha de conhecimentos de qualidade.

Docsie Vocally é um serviço completo de monitorização e resposta de feedback. Permite aos leitores classificar peças individuais de documentação numa escala de um a cinco, com comentários para explicar as razões da sua classificação. Docsie Owners e Admins podem ler este feedback, obtendo uma visão do sucesso e das deficiências da sua documentação.

As bases de conhecimento de auto-serviço são concebidas para minimizar os requisitos de apoio, mas isto também significa que é pouco provável que os clientes persistam com má documentação - em vez disso, procuram uma alternativa com concorrentes que forneçam melhor documentação. Para resolver este problema, Docise Vocally registará as interacções dos utilizadores à medida que estes lêem a sua documentação. Isto irá realçar onde encontraram um problema num documento, e que conteúdo está a causar o problema. Os escritores podem utilizar este feedback para editar a documentação e agir de acordo com o feedback do utilizador. Com o tempo, isto irá melhorar a qualidade do conhecimento da documentação, capacitando os clientes a ajudarem-se a si próprios.

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

Resumidamente, os clientes preferem e esperam um auto-serviço de qualidade, e fornecer esta opção pode reduzir significativamente os custos de apoio. Ao criar uma base de auto-serviço em Docsie, e melhorando a qualidade da documentação com feedback através de Docsie Vocally - é possível atender às exigências dos clientes através de documentação digital. Leia mais em Docsie Vocally aqui.

Documento Versão*

Particularmente com empresas tecnológicas, novas versões de software ou serviços podem introduzir problemas de documentação. A nova versão pode incluir fluxos de trabalho diferentes das versões anteriores, ou terminologia diferente que pode confundir os utilizadores. Simultaneamente, 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 os clientes.

Trata-se de uma melhor prática importante com documentação digital. Os clientes podem precisar de versões mais antigas do seu software para compatibilidade com o seu hardware, ou simplesmente optar por não actualizar para uma nova versão. Assim, as empresas devem sempre atender à sua base de utilizadores, independentemente do número da versão utilizada.

Docsie aborda este problema com a versão de documentos. Quando se actualiza um documento em Docsie, é possível manter versões anteriores para fins de redundância. Os clientes na versão 2 do seu serviço podem seleccionar a documentação correcta, tendo os clientes na versão 1 ainda acesso a documentação mais antiga. A isto chama-se fragmentação; quando a sua base de clientes é dividida em múltiplas versões do mesmo software. Docsie reduz o impacto da fragmentação, assegurando que o conhecimento esteja disponível, independentemente da versão utilizada.

A versão do documento garante que a informação correcta está disponível quando necessário. Também ajuda na rastreabilidade, especialmente quando vários escritores estão a trabalhar na mesma peça de conteúdo. A versão também reduz a duplicação, consolidando a sua documentação para facilidade de acesso.

O seu negócio actualiza regularmente a sua documentação? Os seus clientes têm dificuldade em encontrar a informação certa para as versões actuais e históricas do seu software e serviços? Em caso afirmativo, pode estar na altura de aplicar as melhores práticas de versão de documentos através de um DMS como o Docsie. Pode encontrar mais informações sobre a versão de documentos Docise aqui.

Hábitos de documentação da força de trabalho

O seu pessoal cria documentação, mas também pode criar problemas com a documentação. Durante a fase de rascunho, os escritores podem utilizar tamanhos ou tipos de letra diferentes, ou iconografia e obras de arte desactualizadas. Estas diferenças são fáceis de perder para os funcionários que trabalham com conteúdo todos os dias, mas os clientes são mais propensos a reparar. O resultado é documentação inconsistente, motivada por inconsistências na abordagem à criação e publicação de conteúdos em toda a sua força de trabalho.

Docsie ajuda as empresas a lidar com a inconsistência de conteúdos com o Docsie Documentation Hub. Pode definir um tipo e tamanho de fonte padrão, adicionar logotipos de empresas ou obras de arte, e definir parâmetros de folhas de estilo CSS para utilização num website de uma empresa ou base de conhecimentos. Estas escolhas propagar-se-ão de Docsie para qualquer página web com conteúdo Docsie incorporado, usando as mesmas cores, fontes e logótipos em todos os locais onde o seu conteúdo é publicado.

Isto simplifica a gestão de conteúdos e os fluxos de trabalho editoriais. Em vez de editar páginas individuais, as empresas podem definir um quadro de concepção de conteúdos uma vez em Docsie e aplicar essas alterações em todo o lado. Isto é conhecido como gestão centralizada ou orquestração. O processo de edição de cada documento ou página individualmente pode parecer exequível para bibliotecas de conteúdo mais pequenas, mas este processo não será eficiente à medida que a biblioteca cresce em largura e profundidade.

Em resumo, Docsie trabalha para proteger os seus fluxos de trabalho de gestão de conteúdos no futuro, minimizando a carga de trabalho administrativo de baixo nível. Ao começar com a escala em mente, grandes bibliotecas de conteúdos podem ser geridas com simplicidade - definindo uma vez as estruturas de concepção de conteúdos e implantando-as em todo o lado com Docsie. Pode saber mais sobre Docsie Customized Documentation Hubs 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 a gestão e os fluxos de trabalho de publicação. Pode armazenar documentação numa intranet ou num site SharePoint, em Dropbox ou Google Drive, e partições de armazenamento on-premise ou em nuvem. Cada opção aqui funciona isoladamente, mas pode causar caos quando usada simultaneamente.

Um funcionário precisa de ter acesso a um documento. O documento é armazenado num sítio 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-o automaticamente para a nuvem. O funcionário envia o documento via Slack a um colega. São quatro cópias do mesmo documento em circulação na sua rede informática, com descentralização através de quatro serviços ou ferramentas diferentes.

A Docsie enfrenta este caos descentralizado centralizando os documentos num único local de armazenamento. Quando carrega um documento, Docsie coloca o documento numa prateleira. Referimo-nos a documentos como livros, com cada prateleira cheia de livros para formar uma biblioteca de conteúdos. Os funcionários podem entrar na Docsie para encontrar toda a sua documentação, com filtragem que fornece documentação relevante por departamento ou antiguidade, utilizando controlos de acesso baseados em funções (RBAC). A partir daqui, os funcionários podem publicar documentos directamente no seu website, editar texto da documentação, verificar diferentes versões, e ver o feedback dos clientes ou colegas.

Agora, quando um empregado precisa de ter acesso a um documento, tudo o que tem de fazer é abrir o Docsie. Podem pesquisar documentos, exportar em formatos de ficheiro comuns, e partilhar ligações directas a livros ou prateleiras Docsie. Para utilizadores externos, podem ser convidados pelos Proprietários e Administradores para acesso directo a livros e prateleiras Docsie autorizados, sem comprometer a segurança. É como pastas e ficheiros num disco rígido, mas com um pouco de magia Docsie! Pode saber mais sobre as prateleiras e livros Docsie aqui.

Risco e Conformidade da Governação de Documentos

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

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

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

Este documento é sensível, como posso impedir o acesso não autorizado? Como posso dar permissões de escrita à minha equipa, ao mesmo tempo que só dou acesso a outras equipas só de leitura? Um escritor freelance precisa de permissão para editar este documento, como o posso fazer? Se o seu negócio está a fazer estas perguntas, Docsie tem as respostas! Pode encontrar mais informações sobre a gestão de permissões Docsie aqui.

Colaboração da equipa

O conteúdo raramente é trabalhado por uma única pessoa. Quando vários escritores estão a trabalhar na sua biblioteca de documentação, a colaboração é fundamental.

Que processos seguem os seus empregados quando trabalham com documentação? Um exemplo seria pesquisar numa unidade de rede por documentos existentes e descarregar para um computador. Em seguida, o redactor pode enviar um rascunho final por correio electrónico a um colega, para mais provas. O rascunho aprovado pode então ser carregado para um sistema de gestão de conteúdos (CMS) pronto para publicação. Mais tarde, alguém repara num problema e envia uma versão anotada de volta ao escritor via Slack. Este fluxo de trabalho pode funcionar, mas pode ser simplificado.

Docsie reduz o número de ferramentas de que necessita com uma funcionalidade de colaboração de equipa abrangente. Pode encontrar documentos em Docsie, escrever e editar, partilhar alterações com os membros da equipa, conversar e anotar, e publicar na Internet sem nunca sair do painel de instrumentos Docsie. Isto nega a necessidade de descarregar, carregar, enviar por e-mail e gerir um CMS - permitindo-lhe simplesmente gerir os seus documentos com Docsie! Os membros da equipa podem ser etiquetados usando @mention, as conversas de chat são isoladas para cada livro Docsie, e os freelancers externos podem ser convidados com facilidade para colaboração total da equipa em qualquer local.

Ao minimizar o número de ferramentas necessárias, os empregados podem concentrar-se na criação de conteúdos em vez de mudar de software. Isto acelera os fluxos de trabalho de criação de conteúdo ao minimizar os cliques desperdiçados, sendo os comentários e sugestões dos colegas facilmente acessíveis na barra de ferramentas à direita. Acabou-se a partilha de links, acabaram-se as versões desactualizadas de documentos, acabaram-se os emails perdidos ou as mensagens de chat - tudo o que tem a ver com os seus documentos está centralizado em Docsie.

Aplicar as Melhores Práticas aos seus Médicos com Docsie

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

É aí que entra o Docsie. A Docsie baseia-se nestas melhores práticas de documentação, aplicando-as automaticamente para racionalizar os fluxos de trabalho de criação, gestão e publicação de conteúdos. A plataforma foi concebida para trabalhar com todo o tipo de documentação, alinhando-se de perto com os requisitos típicos do DMS empresarial. Durante a importação e exportação, a documentação Docsie utiliza formatos de ficheiro abertos e compatíveis para aumentar a acessibilidade. As empresas podem ler e agir com base no feedback da documentação do cliente usando Docsie Vocally, melhorando a qualidade do conhecimento e reduzindo os erros de conteúdo. A versão dos documentos permite reter versões históricas para a redundância de informação. As estruturas de marca e concepção de conteúdos podem ser definidas uma vez e aplicadas em todo o lado com o Hub de Documentação Personalizada. Tudo é armazenado num único local -- o Portal Docsie -- para que os funcionários possam encontrar rapidamente um documento em vez de procurarem no seu computador, drive de nuvem, ou e-mail. As permissões podem ser definidas para gerir o GRC, impedindo o acesso não autorizado a documentos sensíveis. Finalmente, os colegas podem conversar, partilhar, ligar, anexar, e conceder acesso a contratantes para colaboração centralizada da equipa no Docsie.

Crie documentação que os seus clientes vão adorar, sem a complexidade. Se o seu negócio está à procura de uma solução DMS, considere dar uma tentativa à Docsie! Basta entrar em contacto com a nossa equipa de vendas, que de bom grado o acompanhará 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


Subscribe to the newsletter

Stay up to date with our latest news and products