Guia do Embaixador
Como documentar sua área
O guia de instalação te deixou com o hub4u aberto no VS Code. Esta página é o que vem depois: como tirar da sua cabeça o que a sua área sabe, sem você digitar documento nenhum.
A parte que trava todo mundo não é a ferramenta. É achar que documentar significa sentar na frente de uma tela em branco e escrever trinta páginas. Não é isso, e se fosse ninguém entregaria. O que se pede é mais simples: fale o que você sabe. O Claude organiza, formata, interliga e devolve o que ficou faltando.
Imagine que você foi promovido e sai da empresa em uma semana. Um profissional de fora assume sua cadeira. Você tem um dia para passar tudo e seis dias para conferir se a pessoa entendeu.
O que você escreveria nesse um dia? Escreva isso. Se o documento não serve para essa pessoa, ele não está pronto.
É pequeno de propósito. Serve para você pegar o jeito e para a gente calibrar o padrão antes de você escrever trinta documentos no formato errado. As semanas 2 a 4 são o resto da lista, na ordem que você definir.
Hoje o /publicar consolida o seu trabalho e para antes de subir. O destino no repositório da empresa, e quem tem acesso a ele, ainda estão sendo definidos.
Isso não te bloqueia em nada. Documentar é o trabalho desta fase; publicar é um passo separado que vem depois, e o que você escrever agora sobe inteiro quando o destino existir. Nada se perde e nada precisa ser refeito.
Quando estiver definido, esta página é atualizada no mesmo link e você recebe um aviso no canal. Não guarde cópia desta página: volte nela.
/iniciar lê o contexto da sua área e o estado do repositório, e te diz em uma linha o que ainda falta documentar. Você não precisa lembrar onde parou./setup antes. O /setup roda uma vez só, na vida./estruturar te devolve a ordem de ataque: quais itens documentar primeiro. Rode ele de novo, mais tarde, e ele vira auditoria: diz o que falta, o que está sem fórmula, o que ficou desconectado./documentar escreve um item por vez: uma cadeira, um indicador ou um processo. E, no mesmo passo, amarra ele nos outros dois tipos. Documento solto não serve para nada, então a interligação não é opcional.| Tipo | Pasta | Formato |
|---|---|---|
| Cadeira | estrutura/ | Sempre arquivo |
| Indicador | indicadores/ | Sempre pasta, com o arquivo oficial de dados dentro |
| Processo | processos/ | Arquivo ou pasta. O Claude decide e explica o motivo |
estrutura/. Uma cadeira júnior de SAF comporta 10 chamados por dia. Se quem está nela hoje entrega 3 e você registrar 3, a empresa perde a régua: não sabe mais se o problema é a cadeira, a pessoa ou o headcount. Registre o tamanho da cadeira. Se ninguém sabe, escreva "não medido", que é resposta válida e é informação./publicar tem dois momentos, e ele decide qual rodar pelo que você pedir. Consolidar é seguro e você roda sempre. Publicar torna o trabalho visível para a empresa inteira, e só acontece quando você pede.| Se você disser | O que acontece |
|---|---|
| "salva", "consolida", "organiza o que eu fiz" | Atualiza os index.md de todos os níveis, fecha versão e roda a auditoria. Fica tudo na sua máquina |
| "publica", "sobe", "terminei essa rodada" | Consolida e depois copia para o repositório da empresa só o que está vigente |
rascunho. Você marca vigente quando ele já pode ser usado como referência por alguém de outra área. É esse campo, e só ele, que decide o que a empresa vê. Rascunho pode ficar meses em rascunho; publicar rascunho é o problema._contexto/publicacao.md dentro da sua pasta, que é a fonte única: se algum documento disser outra coisa, ele vence.O caminho que mais rende, e o mais subestimado. Falando, você entra em detalhe que jamais digitaria: a exceção, o caso estranho, o "ah, mas quando é fim de mês a gente faz diferente". É exatamente esse detalhe que faz o documento servir para quem vai assumir a cadeira.
| Quando usar | Você vai levantar a área inteira, ou um bloco grande dela |
|---|---|
| Quem chamar | Alguém que conhece a área tanto quanto você ou mais. Para processo, chame quem executa, não só quem gerencia. Quem executa sabe onde trava |
| Quanto tempo | 45 a 60 min para as cadeiras · 40 a 50 min para os indicadores · 30 a 40 min por processo |
| Pauta pronta | templates/roteiros-entrevista/, uma por tipo |
Essa é a transcrição de uma reunião de levantamento das cadeiras da área [SUA AREA]. Organiza no padrão da casa e me diz, cadeira por cadeira, o que ficou faltando. Não preenche buraco com dedução plausível: o que não foi dito vira pendente, não medido ou a confirmar. Nome de pessoa ou de sistema que veio deturpado pela transcrição automática, marca como (a confirmar) e não chuta a grafia. Atenção na capacidade: eu quero quanto a CADEIRA comporta quando bem ocupada, não quanto a pessoa que está nela entrega hoje. Se a transcrição misturou os dois, me aponta.
Levantamento de indicadores da área [SUA AREA]. Organiza no padrão, quebra o grão onde der e me lista o que ficou sem fórmula ou sem fonte. Para cada indicador eu preciso das quatro obrigatórias: o que é em uma frase, como calcula com numerador e denominador nomeados, de onde vem o dado sistema por sistema, e qual é o arquivo oficial. Nenhuma pode ficar vaga. Fecha me dizendo, para cada um, o que ele NÃO diz.
Reunião sobre o processo [NOME DO PROCESSO] da área [SUA AREA]. Escreve no padrão da casa e me diz onde o passo a passo ficou vago demais para alguém executar sem ajuda. O bloco de travas é o que mais importa: onde o processo para, o que depende de outra área, qual o erro que gente nova sempre comete. Se a transcrição não cobriu isso, me diz que virou pauta da próxima conversa.
Você não precisa de outra pessoa. Abre o Claude e vai contando o que a área faz, sem ordem e sem se preocupar com formato. Deixa sair. Depois pede para ele organizar.
| Quando usar | Não tem com quem falar, ou tem uma janela solta de 20 minutos |
|---|---|
| Quanto tempo | 15 a 20 min por bloco. Aguenta ser feito em pedaços |
| A vantagem | Quinze minutos hoje sobre um processo, vinte amanhã sobre outro. O Claude empilha e você fecha depois |
Vou falar sem ordem sobre [ASSUNTO] da minha área. Não me interrompe e não organiza ainda. Só escuta e vai guardando. Quando eu disser que terminei, você me mostra: 1. o que dá pra virar cadeira, indicador ou processo 2. o que ficou faltando em cada um pra virar documento de verdade 3. o que eu falei que não é conhecimento de área e deve ficar de fora
Terminei. Organiza o que eu falei. Escolhe UM item pra documentar agora, o que estiver mais completo, e roda /documentar nele. O resto vira pendência declarada no index, não documento pela metade.
Aqui o Claude vira o entrevistador e você não precisa saber conduzir. Serve quando você reuniu o time e não quer ficar com a pauta na mão, e serve também quando você é a pessoa entrevistada.
| Quando usar | Você reuniu o time e quer que a conversa tenha trilho sem você gerenciar as perguntas |
|---|---|
| Como funciona | Você cola o prompt, ele faz uma pergunta por vez, você dita ou digita a resposta do time, ele segue |
| Quanto tempo | 30 a 60 min, igual à entrevista gravada |
Você vai conduzir uma entrevista comigo agora, ao vivo, com o meu time na sala. Objetivo: [mapear as cadeiras da minha área / levantar os indicadores / destrinchar o processo X]. Regras da condução: - usa a pauta de templates/roteiros-entrevista/ como trilho, mas não lê ela pra mim - UMA pergunta por vez, e espera minha resposta antes da próxima - quando minha resposta for rasa, insiste antes de seguir - quando aparecer uma exceção ou um caso estranho, para o roteiro e puxa esse caso - não me corrige durante, só anota No fim, me mostra o que você conseguiu montar e a lista do que ficou faltando.
Boa parte do que a sua área sabe já está escrita em algum lugar: um manual velho, um slide de treinamento, um e-mail longo, uma planilha comentada. E o trabalho que você acabou de executar é matéria-prima fresca.
obsoleto e sai de circulação.Esse documento já existe na área [SUA AREA]. Antes de escrever qualquer coisa, me diz: 1. de quem é e de quando é 2. o que dele ainda vale e o que já mudou 3. qual objeto do repositório deveria receber essa informação: cadeira, indicador ou processo 4. se é caso de criar novo ou de atualizar um que já existe Não cria versão paralela só pra organizar, e não trata o que está escrito como verdade só porque está escrito.
Acabei de [o que você fez]. Documenta o método, a decisão que eu tomei e o motivo dela, e o que vai ser útil de novo na próxima vez. Não registra cada clique nem raciocínio descartável. Se isso já tem um processo escrito, atualiza ele e sobe a versão com o racional em vez de criar documento novo.
Grava a reunião e devolve a transcrição inteira, pronta para colar. Roda por cima de qualquer chamada, sem entrar como participante e sem aquele robô que aparece na sala e constrange todo mundo.
| Resolve | O caminho A inteiro. Sem transcrição, sobra a sua memória do que foi dito, que é bem menos do que foi dito |
|---|---|
| Vale se | Você vai documentar por reunião, que é o caminho que mais rende |
| Na prática | Termina a reunião, abre a transcrição, copia tudo, cola no Claude com o prompt do caminho A |
Você fala e o texto aparece digitado, em qualquer campo do computador, inclusive dentro do painel do Claude. Não é ditado de celular: ele limpa a fala, tira o "é", o "tipo assim" e a repetição, e entrega texto que já dá para usar.
| Resolve | O caminho B, e o caminho C quando você está anotando o que o time responde |
|---|---|
| Vale se | Você pensa falando e trava escrevendo. Para essa pessoa, muda o jogo |
| Na prática | Segura a tecla, fala por dois minutos, solta. O parágrafo aparece pronto no painel |
O erro de calendário mais comum aqui é tratar documentação como tarefa de sobra, daquelas que se faz "quando der". Não dá, nunca. O que funciona é o contrário: duas janelas fixas por semana, na agenda, com o mesmo horário toda semana, e uma reunião gravada logo no começo.
/estruturar com a transcrição e fechar o levantamento/estruturar em auditoria no fim de cada semana para ver o que falta/iniciar. Ele te diz o que está pendente e você escolhe o item./documentar, um item por vez. Dois itens bem escritos valem mais que cinco pela metade./publicar em modo consolidar. Fecha os index, fecha versão, roda a auditoria.vigente sobe, e quem decide isso é você, documento por documento.Meu Drive/hub4u/<sua-area>: o cliente do Google Drive te dá backup sem você pensar nisso, e isso não publica nada, porque o repositório da empresa é outro lugar. A única coisa proibida é trabalhar direto na pasta da sua área dentro do Shared Drive. Ali é destino, não oficina.Repete até o documento passar na régua: se você saísse em uma semana, alguém de fora assumiria sua cadeira com o que está escrito? Se sim, está pronto. Se não, tem mais uma conversa a fazer.
Travou em qualquer ponto, ou não sabe por onde começar? Fale com quem está conduzindo o programa antes de improvisar. Ninguém precisa descobrir sozinho.