Vou escrever documentação para desenvolvedores, docs de API e um readme claro

Sua biblioteca é boa. Seu README tem três linhas e um TODO. Por isso ninguém a adota.

Sou engenheiro de software com mais de 10 anos de experiência em .NET, Python e DevOps, e escrevo a documentação que eu gostaria que os projetos de outras pessoas tivessem.

O QUE VOCÊ RECEBE

- Um README que leva alguém do clone até rodar em cinco minutos

- Referência da API escrita a partir do seu código real, não adivinhada pelos nomes

- Exemplos funcionando - eu executo cada um antes de enviar

- Seções claras de instalação, configuração e resolução de problemas

- Markdown, MkDocs, Docusaurus ou arquivos simples

- Inglês ou alemão (nativo)

PERFEITO PARA

Responsáveis por projetos open-source, equipes de SDK e API, equipes internas de plataforma e fundadores que precisam de documentação antes de um lançamento ou rodada de financiamento.

ENVIE-ME

Acesso ao repositório (leitura é suficiente), quem é o leitor - usuário final, integrador ou colega de equipe - e qualquer coisa que atualmente confunda as pessoas. Suas três principais dúvidas de suporte valem mais do que uma especificação.

Não armazeno credenciais. NDA é bem-vindo.

Documentação que continua crescendo? Pergunte sobre uma assinatura - uma quantidade fixa de trabalho de documentação todo mês, sem necessidade de rebriefing.