AFFiNE para serviços de TI

Documentação de TI para projetos de clientes.

A documentação de TI explica como um sistema é construído, configurado, operado e repassado a outra equipe. Use o AFFiNE para conectar diagramas de arquitetura a notas de configuração, decisões e procedimentos de suporte. Uma passagem útil identifica o responsável atual, as referências às fontes, os problemas pendentes e a próxima ação para a equipe que recebe o trabalho.

Google Meet de 30 minutos Fluxo de trabalho, implantação e necessidades da equipe

Espaço de trabalho ilustrativo: Resumo da solução — migração do portal

Visualização do espaço de trabalho
Resumo da solução — migração do portalEspaço de implementaçãoTransferência técnicaNota de conhecimento de suporteNotas de reunião

Página · equipe de soluções · exemplo fictício

Resumo da solução — migração do portal

Escopo
Substituir o ponto de acesso aos documentos
Decisão
Manter o provedor de identidade atual
Transferência
Perguntas de operações

Questão de projeto em aberto: confirmar com o cliente as necessidades de retenção.

Mesmo projeto · tela Edgeless
Resumo da solução — migração do portal — tela ilustrativaNós: Usuários, Novo portal, Repositório de documentos, Provedor de identidade, Transferência para operações. Conexões: Usuários a Novo portal; Novo portal a Repositório de documentos; Novo portal a Provedor de identidade (login · mantido); Provedor de identidade a Transferência para operações (perguntas).
Usuários
Novo portal
Repositório de documentos
Provedor de identidade
Transferência para operações
login · mantido
perguntas
  • O novo ponto de acesso no escopo, entre usuários e repositório atual.
  • A decisão de manter o provedor de identidade atual, desenhada no caminho de login.
  • As perguntas para operações são vinculadas do diagrama à transferência.

Sem Bordas

Espaço de implementação

Desenhe os componentes e suas conexões. Explique decisões, premissas e questões em aberto em um resumo da solução junto ao diagrama.

Premissa
Serviço de identidade atual
Opção
Ponto de acesso compartilhado aos documentos
Pergunta
Confirmar necessidades de retenção
Mesmo projeto · tela Edgeless
Espaço de implementação — tela ilustrativaNós: Necessidade do cliente, Mapa do sistema, Opções, Decisão, Necessidades de retenção?. Conexões: Necessidade do cliente a Mapa do sistema; Mapa do sistema a Opções; Opções a Decisão (escolhida); Necessidades de retenção? a Decisão (bloqueia).
Necessidade do cliente
Mapa do sistema
Opções
Decisão
Necessidades de retenção?
escolhida
bloqueia

Página + tabela

Transferência técnica

Reúna escopo, notas de configuração e lista de entrega. Use uma tabela de responsáveis e pendências atualizada pela equipe.

ItemResponsávelStatus
Piloto de migração de documentosEquipe de entregaRevisar premissas
Necessidades de retençãoArquiteto de soluçõesQuestão em aberto
Procedimentos operacionaisConsultorEm elaboração

Tabela mantida manualmente · sem automação de chamados

Mesmo projeto · tela Edgeless
Transferência técnica — tela ilustrativaNós: Usuários, Novo portal, Repositório de documentos, Provedor de identidade, Transferência para operações. Conexões: Usuários a Novo portal; Novo portal a Repositório de documentos; Novo portal a Provedor de identidade (login · mantido); Provedor de identidade a Transferência para operações (perguntas).
Usuários
Novo portal
Repositório de documentos
Provedor de identidade
Transferência para operações
login · mantido
perguntas
  • O novo ponto de acesso no escopo, entre usuários e repositório atual.
  • A decisão de manter o provedor de identidade atual, desenhada no caminho de login.
  • As perguntas para operações são vinculadas do diagrama à transferência.

Página

Nota de conhecimento de suporte

Vincule arquitetura, procedimentos operacionais e problemas pendentes em uma página de transferência. Verifique o método de compartilhamento ou exportação Markdown antes da entrega.

Contexto do sistema
Notas de arquitetura
Operações
Procedimentos conhecidos
Pendências
Perguntas para a próxima equipe

Exportação Markdown disponível · teste primeiro o compartilhamento

Quadro Edgeless incorporado

Exportação Markdown — teste o resultado antes da entrega

Mesmo projeto · tela Edgeless
Nota de conhecimento de suporte — tela ilustrativaNós: Usuários, Novo portal, Repositório de documentos, Provedor de identidade, Transferência para operações. Conexões: Usuários a Novo portal; Novo portal a Repositório de documentos; Novo portal a Provedor de identidade (login · mantido); Provedor de identidade a Transferência para operações (perguntas).
Usuários
Novo portal
Repositório de documentos
Provedor de identidade
Transferência para operações
login · mantido
perguntas
  • O novo ponto de acesso no escopo, entre usuários e repositório atual.
  • A decisão de manter o provedor de identidade atual, desenhada no caminho de login.
  • As perguntas para operações são vinculadas do diagrama à transferência.

Página

Notas de reunião

Transforme dúvidas recorrentes de suporte em páginas reutilizáveis. Inclua a configuração, por que foi escolhida e um link para as notas de implementação.

Por que esta configuração?

Justificativa do projeto, escrita uma vez e vinculada às notas de suporte.

Relacionado
Nota de implementação
Mesmo projeto · tela Edgeless
Notas de reunião — tela ilustrativaNós: Usuários, Novo portal, Repositório de documentos, Provedor de identidade, Transferência para operações. Conexões: Usuários a Novo portal; Novo portal a Repositório de documentos; Novo portal a Provedor de identidade (login · mantido); Provedor de identidade a Transferência para operações (perguntas).
Usuários
Novo portal
Repositório de documentos
Provedor de identidade
Transferência para operações
login · mantido
perguntas
  • O novo ponto de acesso no escopo, entre usuários e repositório atual.
  • A decisão de manter o provedor de identidade atual, desenhada no caminho de login.
  • As perguntas para operações são vinculadas do diagrama à transferência.
Espaço de trabalho ilustrativo com conteúdo fictício; não é uma captura do produto nem um caso de cliente. No Edgeless: arraste objetos, use Mão para navegar ou Ctrl/⌘ + rolagem para ajustar o zoom. As ferramentas de desenho são referências visuais.
  • Explicar as decisões de arquitetura junto ao diagrama

    Mostrado no fluxo 01

  • Manter visíveis o escopo e os responsáveis da implementação

    Mostrado no fluxo 02

  • Reutilizar respostas a dúvidas recorrentes de suporte

    Mostrado no fluxo 04

Da tarefa ao espaço de trabalho

Documentação de TI da arquitetura ao suporte.

Crie um resumo da solução, acompanhe notas de implementação, prepare uma transferência e reutilize respostas de suporte.

Mapa de tarefas e recursos dos quatro exemplos desta página
TarefaDocumentosSem BordasTabelasEquipeExportaçãoResultado
01 · Arquiteto de soluçõesEscrever documentação de arquitetura de softwareDocumentosSem BordasResumo da solução
02 · Líder de entregaOrganizar documentação de implementaçãoDocumentosTabelasEquipeEspaço de implementação
03 · ConsultorPreparar uma transferência técnicaDocumentosSem BordasExportaçãoTransferência técnica
04 · Equipe de suporteCriar uma base de conhecimento de TIDocumentosEquipeNota de conhecimento de suporte

01Arquiteto de soluções

Escrever documentação de arquitetura de software

Desenhe os componentes e suas conexões. Explique decisões, premissas e questões em aberto em um resumo da solução junto ao diagrama.

Tarefa
Explicar ao cliente uma arquitetura proposta
No AFFiNE
Relações do sistema desenhadas no Edgeless; cada escolha explicada na página
Resultado
Resumo da solução

Recursos utilizados

Sem BordasExemplo fictício

Resumo da solução

Resumo da solução — tela ilustrativaNós: Necessidade do cliente, Mapa do sistema, Opções, Decisão, Necessidades de retenção?. Conexões: Necessidade do cliente a Mapa do sistema; Mapa do sistema a Opções; Opções a Decisão (escolhida); Necessidades de retenção? a Decisão (bloqueia).
Necessidade do cliente
Mapa do sistema
Opções
Decisão
Necessidades de retenção?
escolhidabloqueia
Premissa
Serviço de identidade atual
Opção
Ponto de acesso compartilhado aos documentos
Pergunta
Confirmar necessidades de retenção
Layout ilustrativo com conteúdo fictício; não é uma captura do produto.

02Líder de entrega

Organizar documentação de implementação

Reúna escopo, notas de configuração e lista de entrega. Use uma tabela de responsáveis e pendências atualizada pela equipe.

Tarefa
Iniciar uma entrega com a discussão atual em um só lugar
No AFFiNE
Página de escopo com uma tabela simples mantida pela equipe
Resultado
Espaço de implementação

Recursos utilizados

Página + tabelaExemplo fictício

Espaço de implementação

ItemResponsávelStatus
Piloto de migração de documentosEquipe de entregaRevisar premissas
Necessidades de retençãoArquiteto de soluçõesQuestão em aberto
Procedimentos operacionaisConsultorEm elaboração

Tabela mantida manualmente · sem automação de chamados

Layout ilustrativo com conteúdo fictício; não é uma captura do produto.

03Consultor

Preparar uma transferência técnica

Vincule arquitetura, procedimentos operacionais e problemas pendentes em uma página de transferência. Verifique o método de compartilhamento ou exportação Markdown antes da entrega.

Tarefa
Deixar à equipe do cliente uma transferência fácil de consultar
No AFFiNE
Página de transferência com notas de arquitetura e tela vinculadas; exportação Markdown testada antes da entrega
Resultado
Transferência técnica

Recursos utilizados

PáginaExemplo fictício

Transferência técnica

Contexto do sistema

Notas de arquitetura

Operações

Procedimentos conhecidos

Pendências

Perguntas para a próxima equipe

Quadro Edgeless incorporado

Exportação Markdownteste o resultado antes da entrega

Exportação Markdown disponível · teste primeiro o compartilhamento

Layout ilustrativo com conteúdo fictício; não é uma captura do produto.

04Equipe de suporte

Criar uma base de conhecimento de TI

Transforme dúvidas recorrentes de suporte em páginas reutilizáveis. Inclua a configuração, por que foi escolhida e um link para as notas de implementação.

Tarefa
Responder uma vez a uma dúvida recorrente, com seu raciocínio
No AFFiNE
Página reutilizável no espaço compartilhado, vinculada à nota de implementação
Resultado
Nota de conhecimento de suporte

Recursos utilizados

PáginaExemplo fictício

Nota de conhecimento de suporte

Por que esta configuração?

Justificativa do projeto, escrita uma vez e vinculada às notas de suporte.

RelacionadoNota de implementação

Layout ilustrativo com conteúdo fictício; não é uma captura do produto.

Do exemplo à avaliação

Converse sobre sua documentação para clientes.

Converse sobre notas de arquitetura, transferências de projetos e requisitos de acesso da equipe.

Agende uma demonstração

Escolha um horário com a equipe AFFiNE.

Um espaço de trabalho conectado

Escreva em uma página. Mude o mesmo documento para uma tela.

Os exemplos acima usam os mesmos elementos básicos.

  • Exemplo ilustrativo

    Documentos

    Páginas legíveis com referências, imagens e blocos ricos.

    Explore Docs
  • Exemplo ilustrativo

    Quadro branco Edgeless

    Uma tela para mostrar como ideias e sistemas se relacionam.

    Explore Edgeless
  • Exemplo ilustrativo

    Tabelas e espaço de equipe

    Acompanhe as pendências e editem juntos em espaços compartilhados.

    Explore Teamhub

Exemplos ilustrativos de documentos, quadros brancos e tabelas; não são capturas do produto nem casos setoriais.

Implantação e avaliação

Escolha como executar o espaço de trabalho.

Avalie a carga de trabalho, a infraestrutura e a configuração de IA com quem operará o espaço.

Ilustração de um espaço hospedado na nuvem

Espaço hospedado

Teste um fluxo com material de exemplo permitido antes de ampliar o uso.

  • Aplicativo web do AFFiNE
  • Um espaço de equipe
  • Sem servidores para manter
Converse sobre implantação na nuvem
Auto-hospedar AFFiNE

Pré-requisitos

1 / Docker

Instale Docker e Docker Compose na sua máquina.

2 / Baixar o arquivo Compose mais recente

Baixe compose.yml do repositório do AFFiNE.

3 / Preparar o arquivo de ambiente

Revise as variáveis de ambiente da sua implantação.

Auto-hospedado

Para o AFFiNE auto-hospedado, Docker Compose é a opção de implantação documentada. Os dados do espaço e os arquivos enviados usam a infraestrutura e o armazenamento que você configurar.

  • Docker Compose
  • PostgreSQL
  • Armazenamento de arquivos ou S3
  • Login OIDC
  • Entre pelo seu provedor de identidadeO AFFiNE auto-hospedado oferece suporte a OIDC. Revise os papéis do espaço e o acesso a documentos conforme seus requisitos.
  • A IA é opcionalA IA na instalação auto-hospedada exige um provedor configurado e pode ser desativada. O uso de chave própria é marcado como experimental.
  • Licenciamento para redes restritasUma licença instalável é ativada sem contatar os servidores de licenças do AFFiNE. Isso não faz todos os recursos funcionarem offline.
  • Backup e restauraçãoO processo está documentado, incluindo uma restauração de teste. Execute-o no seu ambiente.
  1. O material de clientes compartilhará um espaço com o conhecimento interno?
  2. Como cada transferência será compartilhada ou exportada?
  3. Qual provedor de identidade o piloto deve usar?

Esta página não afirma suporte a SAML, SCIM, certificações setoriais nem aprovação para uma carga de trabalho específica.

Referências do produto: AFFiNE Enterprise e documentação em inglês sobre Docker Compose, login via OIDC e configuração de IA.

Continue explorando · Modelo geral

Modelo existente de procedimento operacional

Um modelo geral para documentar uma tarefa operacional repetível.

Antes de começar

Dúvidas da sua equipe.

Como equipes de serviços podem usar o AFFiNE para documentar TI?

Use documentos para configurações e procedimentos, quadros brancos para arquitetura e tabelas para responsáveis e questões em aberto. Estes exemplos cobrem documentação; descoberta de ativos, cofres de senhas, RMM e automação de chamados ficam em ferramentas especializadas.

O que incluir na documentação de arquitetura de software?

Registre o objetivo do sistema, os usuários, componentes, interfaces e contexto de implantação; depois, explique as decisões de projeto e as questões pendentes. Identifique os elementos e as conexões do diagrama para que outra equipe possa interpretá-lo sem o autor original. No AFFiNE, mantenha o diagrama ao lado das premissas, referências às fontes e notas de decisão.

Referência para diagramas (em inglês): modelo C4 para arquitetura de software.

Podemos separar informações de clientes diferentes?

Avalie membros do espaço, acesso a documentos e opções de compartilhamento conforme seus requisitos antes de usar material de clientes. O exemplo não comprova isolamento entre clientes.

Podemos avaliar a auto-hospedagem?

Sim. Docker Compose é a opção documentada de auto-hospedagem, com login pelo seu provedor de identidade via OIDC. Revise a documentação Enterprise com a equipe de infraestrutura e teste um fluxo representativo antes de ampliar a implantação.

Este espaço exige IA?

Não. Estes fluxos usam páginas, telas e tabelas sem exigir IA. No AFFiNE auto-hospedado, a IA precisa de um provedor configurado e pode ser desativada. Revise o provedor e os fluxos de dados antes de ativá-la.

Por onde a equipe deve começar?

Escolha uma tarefa atual de documentação e um pequeno conjunto de material permitido. Avalie se a equipe consegue encontrar, entender e transferir o trabalho antes de ampliar o uso.

Uma conversa sobre sua equipe

Avalie o AFFiNE para a entrega a clientes.

Converse sobre notas de arquitetura, transferências de projetos e requisitos de acesso da equipe.

Google Meet de 30 minutos · Escolha um horário disponível

Prefere e-mail? Fale com vendas