O Cozmos Docs é a nova documentação oficial da plataforma Cozmos. Por isso, reúne num único espaço tudo o que é necessário para criar conta, ligar equipamentos, configurar alarmes, gerir licenças e integrar o Cozmos com outros sistemas.
Além disso, junta as release notes de todos os módulos, está disponível em cinco idiomas e adapta o conteúdo ao nível de acesso de cada utilizador. Desta forma, cada pessoa encontra a informação de que precisa, no momento em que precisa, sem depender de terceiros.
O problema: a informação que ninguém encontra
Numa organização, a adoção de uma nova plataforma raramente falha por falta de funcionalidades. Contudo, falha muitas vezes porque quem a utiliza não sabe por onde começar.
Por exemplo, as dúvidas acumulam-se depressa. Como se liga um equipamento LoRaWAN? Que dados são necessários para um equipamento MQTT? Como se cria um alarme que não dispare ao primeiro atraso de comunicação? Onde se renova uma licença?
Quando a resposta está espalhada por emails, ficheiros antigos ou na memória de um colega, cada dúvida transforma-se numa interrupção. Consequentemente, a equipa perde tempo. Ao mesmo tempo, os novos utilizadores demoram mais a ser autónomos e o potencial da plataforma fica por explorar.
Por isso, criámos o Cozmos Docs.
Cozmos Docs: uma documentação pensada para quem opera o Cozmos
O Cozmos Docs não é um manual técnico genérico. Pelo contrário, foi escrito a partir dos ecrãs reais da plataforma, com os mesmos nomes de botões, campos e menus que o utilizador encontra no dia-a-dia.
Além disso, cada página segue a ordem do próprio produto. Assim, o utilizador pode ter a documentação aberta ao lado do Cozmos e acompanhar cada passo à medida que o executa.
Em resumo, a documentação está organizada em seis grandes áreas:
- Introdução, com a apresentação da plataforma, dos módulos e da própria documentação;
- Tecnologias compatíveis, com o que é necessário para ligar equipamentos LoRaWAN, MQTT e outros protocolos, e com a lista de equipamentos compatíveis;
- Como começar, com a criação de conta, o início de sessão e os primeiros passos;
- Guias, com a dashboard, o mapa, o histórico, a gestão de equipamentos, os alarmes e os dados pessoais;
- Cozmos Admin, com as licenças, os utilizadores, as gateways LoRaWAN e os logs;
- Integrações, com a REST API, os Dados públicos e o Repositório de ficheiros.
Do primeiro registo ao primeiro equipamento no Cozmos Docs
O início é o momento em que a documentação faz mais diferença. Por isso, o Cozmos Docs acompanha o novo utilizador desde a criação da conta até à ligação do primeiro equipamento.
Em primeiro lugar, a página Como começar explica cada passo do registo: os dados do utilizador, os dados da entidade, a escolha das licenças e o pagamento. Explica também por que razão cada informação é pedida, como o NIF ou a região fiscal. Este percurso acompanha o novo registo do Cozmos Login 1.2, no qual as licenças e os planos já se escolhem na própria criação da conta.
Em seguida, a secção Tecnologias compatíveis indica, para cada protocolo, os dados que o equipamento precisa de ter, como o DevEUI e a AppKey num equipamento LoRaWAN. Desta forma, o utilizador sabe o que preparar antes de adicionar a primeira estação.
Guias do Cozmos Docs para o trabalho diário
Depois de a conta estar criada, as dúvidas mudam. Ou seja, já não se trata de começar, mas de tirar partido de tudo o que a plataforma oferece.
Os Guias cobrem as áreas que o utilizador utiliza todos os dias:
- Dashboard, com os elementos disponíveis e a forma de os configurar;
- Mapa, com a localização e o estado das estações;
- Histórico, com a análise de dados, as estatísticas e a importação de leituras;
- Gestão de equipamentos, com o que é uma estação, uma variável e a sua associação às licenças, e com a forma de adicionar, visualizar, editar e enviar comandos;
- Alarmes, com os alarmes de variável e de estado, as sugestões de alarmes e os modos de notificação por email, SMS e mensagem de voz;
- Alterar dados pessoais, com o perfil, as regras da palavra-passe e a autenticação de dois fatores.
Além disso, a nova página de introdução à gestão de equipamentos explica os conceitos base do Cozmos. Assim, o utilizador percebe como as estações, as variáveis e as licenças se relacionam antes de começar a configurar.
Informação certa para cada nível de acesso
Nem todos os utilizadores precisam da mesma informação. Por exemplo, um técnico que consulta dados não precisa de saber como se cria um cliente. Em contrapartida, um gestor precisa de saber como se renova uma licença ou como se adiciona um novo utilizador.
Por isso, o Cozmos Docs adapta o conteúdo ao nível de acesso de cada conta. A introdução, as tecnologias compatíveis e o Como começar são públicos. Depois de iniciar sessão com a conta Cozmos, a documentação apresenta as secções a que o utilizador tem acesso:
| Nível | Guias | Integrações | Cozmos Admin |
|---|---|---|---|
| Utilizador | Sim | Sim | Não |
| Gestor | Sim | Sim | Sim |
| Agente | Sim | Sim | Sim |
A sessão é a mesma da plataforma. Consequentemente, não é necessária uma conta adicional nem uma nova palavra-passe. Para quem gere vários clientes, a secção Cozmos Admin segue a mesma lógica da Rede de Agentes.
Outras novidades do Cozmos Docs
Além dos guias e da organização por níveis, o Cozmos Docs reúne outros recursos que até agora estavam dispersos.
Release notes de todos os módulos
Todas as atualizações do Cozmos, do Cozmos Admin, do Cozmos EMS e do Cozmos SIS estão disponíveis na secção Release notes, organizadas por módulo e por versão. Assim, é fácil acompanhar a evolução da plataforma e perceber o que mudou em cada atualização.
Integrações documentadas
A secção Integrações explica como ligar o Cozmos a outros sistemas através da REST API, como publicar dados em tempo real num website com os Dados públicos e como utilizar o Repositório de ficheiros. Além disso, cada integração tem o respetivo manual em PDF e, quando aplicável, a especificação OpenAPI.
Cinco idiomas
A documentação está escrita em português de Portugal e pode ser consultada em inglês, espanhol, alemão e português do Brasil. Desta forma, equipas e parceiros de diferentes países consultam a mesma informação.
Menos dúvidas, mais autonomia
Uma boa documentação não substitui o acompanhamento da equipa Cozmos. No entanto, permite que esse acompanhamento se concentre no que realmente importa.
Quando as respostas às dúvidas mais comuns estão a um clique, o utilizador resolve sozinho grande parte das questões do dia-a-dia. Consequentemente, os novos membros de uma equipa tornam-se autónomos mais depressa. Ao mesmo tempo, as organizações retiram mais valor da plataforma desde o primeiro dia.
Em suma, o percurso de um novo utilizador passa a ser:
Criar conta → Perceber a tecnologia → Ligar o equipamento → Configurar alarmes → Analisar os dados
E, em cada um destes passos, há uma página do Cozmos Docs para o acompanhar.
Uma documentação que cresce com a plataforma
O Cozmos está em constante evolução, e a documentação acompanha esse ritmo. Por fim, cada nova funcionalidade passa a ter o seu lugar no Cozmos Docs, com a mesma linguagem e a mesma estrutura das restantes páginas.
Seja uma organização a dar os primeiros passos com o plano gratuito, seja um parceiro que gere vários clientes no Cozmos Admin, o Cozmos Docs está pensado para responder às dúvidas de cada um.
Conheça o Cozmos Docs 🚀
Aceda ao Cozmos Docs, explore os guias e descubra tudo o que a plataforma Cozmos pode fazer pela sua organização.
Depois, inicie sessão com a sua conta Cozmos e consulte a documentação adaptada ao seu nível de acesso, nas áreas que fazem sentido para o seu trabalho.
