Um computador de mesa antigo

Wiki técnica da plataforma

Problema

Conhecimento de plataforma que existe só na cabeça de quem escreveu é risco operacional. Onboarding fica caro, decisão antiga vira mistério, e a mesma pergunta é respondida no chat toda semana.

Contexto

Criei a wiki técnica que documenta a plataforma na Jmak:

  • arquitetura;
  • fluxos;
  • organização do código;
  • funcionamento da plataforma;
  • conhecimento operacional;
  • decisões técnicas e o motivo de cada uma.

Aprendizado

Documentar mudou como eu escrevo código. Várias vezes comecei a descrever um fluxo, travei na terceira frase e percebi que o texto estava confuso porque o fluxo estava confuso.

Próximo passo

A escrever: o que aconteceu com onboarding e com as perguntas repetidas depois de a wiki existir.

a maior parte dos botões funcionam · procure eles · clique nas folhas
sistema‑1

Wiki técnica da plataforma

Problema

Conhecimento de plataforma que existe só na cabeça de quem escreveu é risco operacional. Onboarding fica caro, decisão antiga vira mistério, e a mesma pergunta é respondida no chat toda semana.

Contexto

Criei a wiki técnica que documenta a plataforma na Jmak:

  • arquitetura;
  • fluxos;
  • organização do código;
  • funcionamento da plataforma;
  • conhecimento operacional;
  • decisões técnicas e o motivo de cada uma.

Aprendizado

Documentar mudou como eu escrevo código. Várias vezes comecei a descrever um fluxo, travei na terceira frase e percebi que o texto estava confuso porque o fluxo estava confuso.

Próximo passo

A escrever: o que aconteceu com onboarding e com as perguntas repetidas depois de a wiki existir.