Materiais

A documentação do seu sistema, escrita pelo Spaccy

Manual, casos de uso, treinamento, vídeo e explicações profundas — gerados a partir do seu próprio código e da sua aplicação rodando, não de um documento que alguém prometeu escrever. Quando o sistema muda, você regera.

Manual técnico e de usuário

Um comando, dois manuais: o técnico com arquitetura, diagramas e trechos de código; o de usuário com passo a passo e screenshots capturados da sua aplicação rodando de verdade. Nada de print desatualizado colado à mão.

comando/manualno seu repodocs/Manual/

Casos de uso escritos a partir do que existe

Percorre as telas, integrações e fluxos que você realmente entregou e escreve os casos de uso no formato Cockburn — fluxo principal, exceções, diagramas e wireframes. É a documentação que o time de produto pede e ninguém tem tempo de fazer.

comando/usecasesno seu repodocs/usecases/

Validação dos fluxos no navegador

Cada caso de uso é executado na aplicação viva, com o usuário certo, e conferido tanto na tela quanto no banco. O que sai é um relatório com veredito por fluxo e evidência em screenshot dos bugs encontrados — antes de o cliente encontrá-los.

comando/validate-usecases

Explicação profunda de qualquer parte

Um documento único que explica um módulo, uma entidade, uma tela ou um conceito do seu sistema unindo a visão de negócio e a técnica. Serve para decidir, para revisar e para responder à pergunta que só uma pessoa do time sabia responder.

comando/explain

Treinamento do time, por público

Monta programas de treinamento em trilhas por audiência — suporte, comercial, engenharia, quem você definir — com capítulos em markdown, diagramas, screenshots reais e vídeo narrado. Onboarding deixa de depender da agenda do sênior.

comando/training

Vídeo narrado do produto

Um tutorial em vídeo, narrado e legendado, produzido dirigindo a sua aplicação real para capturar o percurso. Pronto para treinamento interno, demonstração comercial ou material de suporte.

comando/video

O contexto da sessão, guardado

Registra o mapa mental da sessão de trabalho para você retomar exatamente de onde parou — depois de uma reunião, de uma semana ou de uma troca de pessoa no time.

comando/mindmap

Manual do usuário gerado pelo comando /manual, aberto no visualizador de documentos do Studio, com sumário e um diagrama de instalação.Manual do usuário gerado pelo comando /manual, aberto no visualizador de documentos do Studio, com sumário e um diagrama de instalação.
Um manual real, gerado a partir deste projeto.

Tudo nesta página roda hoje e é o que mantém a documentação do próprio Spaccy em dia. Peça acesso antecipado para experimentar antes de todos.