Docs: notas colaborativas de código aberto e ferramentas de gerenciamento de documentos

Introdução geral

O Docs é uma plataforma de código aberto para anotações colaborativas e gerenciamento de documentos desenvolvida pela equipe do suitenumerique. Ele usa Django e Reagir Criada com tecnologia, o objetivo é fornecer uma ferramenta fácil de usar que ajude os usuários a fazer anotações, gerenciar documentos e compartilhar conhecimento. Essa plataforma suporta colaboração em tempo real com várias pessoas e é adequada para uso em equipe. Seu design é inspirado em Noção O Docs é uma nova versão do software, que é totalmente gratuita e de código aberto, e pode ser implantada pelos próprios usuários. Ele oferece funcionalidade básica de edição de documentos, além de recursos úteis, como sincronização off-line e exportação de arquivos. O Docs, que em sua essência foi projetado para tornar o gerenciamento do conhecimento mais eficiente, ainda está sendo atualizado continuamente e espera-se que seja lançado oficialmente em fevereiro de 2025.

Lista de funções

• Edição colaborativa em tempo realEdição: Várias pessoas editando o mesmo documento ao mesmo tempo, com alterações sincronizadas em tempo real.
• sincronização off-lineNota: Você pode fazer anotações sem conexão com a Internet, e elas são sincronizadas automaticamente quando você se conecta à Internet.
• formato simplesSuporte à digitação básica sem a sintaxe complexa do Markdown.
• Exportação de documentosDocumentos podem ser exportados para PDF, Word e outros formatos.
• Auxílios de IAFunções: fornece funções como geração de texto, resumo de conteúdo, tradução, etc.
• gerenciamento de direitosControle quem pode visualizar ou editar documentos para proteger a privacidade.
• Wiki incorporadoOrganize as anotações da equipe em uma base de conhecimento.
• Suporte a vários idiomasSuporte de tradução por meio da plataforma Crowdin para usuários globais.

Usando a Ajuda

O Docs é uma ferramenta que precisa ser implantada localmente ou em um servidor, e não há uma versão on-line prontamente disponível. Aqui está um guia detalhado de instalação e uso para que você possa começar rapidamente.

Processo de instalação

O Docs requer o Docker e o Docker Compose para ser executado, portanto, certifique-se de que eles estejam instalados em seu computador primeiro. As versões oficiais recomendadas são Docker 20.10.2 e Docker Compose 2.32.4. Você pode verificar as versões com os seguintes comandos:

docker -v
docker compose version

Se não o tiver instalado, você pode acessar o site oficial do Docker para fazer o download e instalá-lo. Depois de instalá-lo, adicione seu usuário ao grupo do Docker para não ter que digitar sudo para cima. A ordem é a seguinte:

sudo usermod -aG docker $USER

Em seguida, reinicie o computador para que o efeito seja efetivo.

Em seguida, faça o download do código do Docs. Abra um terminal e digite:

git clone https://github.com/suitenumerique/docs.git
cd docs

Depois de fazer o download do código, vá para docs para começar a criar o projeto. Execute o seguinte comando:

docker compose up --build

Esse comando baixará automaticamente as dependências, criará o banco de dados e iniciará o serviço. Talvez seja necessário aguardar alguns minutos para a primeira execução. Se você vir o terminal mostrando que o serviço foi iniciado com êxito, a instalação estará concluída.

Os documentos são executados no endereço local por padrão http://localhost:3000. Abra seu navegador e digite esse endereço para acessá-lo. Se você quiser fazer login com uma conta de teste, um endereço de e-mail oficial será fornecido test.docs@yopmail.com e senhas I'd<3ToTestDocs.

Funções principais

Criação e edição de documentos

Depois de fazer login, clique no botão "New Document" (Novo documento) na página, o Docs abrirá uma página em branco e você poderá inserir o texto diretamente. A interface de edição é muito simples e suporta formatação básica, como negrito, itálico, título, etc. Ao editar com vários usuários, você verá os cursores e as alterações de outras pessoas em tempo real. Quando estiver editando com vários usuários, você verá os cursores e as alterações de outras pessoas exibidos em tempo real.

sincronização off-line

Se a rede estiver inoperante, o Docs salvará automaticamente suas alterações localmente. Quando a rede for restaurada, clique no botão "Synchronise" (Sincronizar) no canto superior direito e as alterações serão carregadas no servidor. Não há necessidade de definir nenhuma configuração adicional, o sistema cuidará disso automaticamente.

Exportação de documentos

Quando terminar de escrever o documento, clique na opção "Export" (Exportar) no canto superior direito. .pdfe.doc talvez .odt Formato. Depois de selecionar o formato, clique em "Download" e o arquivo será salvo em seu computador.

Auxílios de IA

O Docs tem alguns recursos de IA incorporados, como a geração ou a tradução de texto. Selecione um trecho de texto, clique no ícone de IA na barra de ferramentas e escolha "Generate" (Gerar) ou "Translate" (Traduzir). Por exemplo, se você digitar "Write an introduction" (Escreva uma introdução), a IA gerará automaticamente o conteúdo. Se você quiser traduzir, selecione o idioma de destino e a IA traduzirá o texto. Esses recursos exigem uma conexão com a Internet.

Configuração de permissões

Deseja controlar quem pode ver ou alterar um documento? Na página do documento, clique no botão "Compartilhar". O docs permite que você defina três permissões: somente leitura, editável e invisível. Digite o endereço de e-mail do colaborador, selecione as permissões e clique em "Confirm" (Confirmar). Depois que as permissões forem definidas, somente as pessoas convidadas poderão acessar o documento.

Criação de um Wiki

O Docs permite que você organize seus documentos em wikis clicando na opção "Wiki" no menu à esquerda e selecionando "New Wiki". Arraste os documentos existentes ou escreva novos conteúdos diretamente no wiki. Quando terminar, os membros da equipe poderão visualizar a base de conhecimento por meio do wiki.

advertência

• O Docs usa o Minio como serviço de armazenamento por padrão. Se você quiser usar outro armazenamento S3 (por exemplo, AWS), será necessário alterar o arquivo de configuração. Consulte o arquivo oficial installation.md Documentação.
• As execuções locais são apenas para fins de teste e não podem ser usadas diretamente em ambientes de produção. A implementação de produção requer configuração adicional, como a configuração de HTTPS.

Com essas etapas, você pode instalar e usar facilmente o Docs, que ainda está em desenvolvimento, mas já atende às necessidades básicas de gerenciamento de notas e documentos.

cenário do aplicativo

1. Gerenciamento de projetos em equipe
   Os membros da equipe usam o Docs para registrar o progresso do projeto e atualizar o status da tarefa em tempo real. Todos podem ver o conteúdo mais recente e evitar que as informações fiquem fora de sincronia.
2. Organização do conhecimento pessoal
   Estudantes ou pesquisadores usam o Docs para fazer anotações e organizar informações. O suporte à exportação facilita a transformação das anotações em um documento ou relatório.
3. Teletrabalho
   As equipes distribuídas usam o Docs para escrever documentos e definir permissões para que somente as pessoas relevantes possam ver o conteúdo confidencial, de forma segura e eficiente.

QA

1. Os documentos são gratuitos?
   Sim, o Docs é totalmente de código aberto e o código é liberado sob a licença MIT. Qualquer pessoa pode fazer o download e usá-lo gratuitamente.
2. É necessário ter conhecimento de programação para usá-lo?
   Não é necessário. Os usuários comuns podem usar os recursos básicos do Docs seguindo as etapas de instalação. Aqueles que sabem programar podem alterar o código para adicionar recursos por conta própria.
3. Ele é compatível com telefones celulares?
   Atualmente, o Docs está disponível na Web e em navegadores móveis, mas não há um aplicativo móvel dedicado, que poderá ser desenvolvido no futuro.