Executando verificação de segurança...
1

Infelizmente não tenho em mãos nenhum exemplo público. Mas não é difícil explicar! É bem similar a um readme.md, porém o foco é direcionado. Num readme você aborda tudo. Os contribuidores, tecnologias, clientes...já a wiki foca em questões e/ou títulos objetivos:

  • "Como requisitar uma API de usuários"
  • "Procedure para alterar os preços de produtos sazonais"
  • "Regras para alteração do contexto da aplicação"
  • "Estruturação das tabelas de conteúdos favoritados"

Uma boa WiKi pode se tornar um guia não apenas para os atuais desenvolvedores, mas para futuras agregações no time de desenvolvimento. É praticamente um tabnews internalizado 🤓.
E claro, de acordo com os relacionamentos dos conteúdos da wiki, é possível criar wikis direcionadas, que foquem apenas em Banco de Dados, Front e Back...e por aí vai, mas claro, precisa ter controle. De nada adianta encher lá de conteúdo "fútil" como por exemplo:

  • "Como criar uma variável"
  • "Alterar padding do botão"

É muito possível que existam outros formatos. Mas hoje é este que usamos e funciona bem. Isso não exime documentações, ok? Nada anula a necessidade de uma boa documentação. Mas pesquisar num conteúdo direcionado, objetivo e personalizado (porque não são regras gerais, mas sim regras próprias para cada projeto e muitas vezes, regras de negócio). E você pode hospedar onde preferir...um documento compartilhado no OneDrive ou internamente numa cloud como Azure ou AWS.

Carregando publicação patrocinada...