Escreverei documentação técnica clara para seu código ou API

Código bom com documentação ruim é abandonado. Seus usuários relatam problemas que a documentação deveria ter respondido, e você responde à mesma pergunta toda semana.

Eu leio seu código real e escrevo uma documentação que corresponde ao que ele realmente faz, ao invés de um modelo genérico com o nome do seu projeto colado.

O QUE EU ESCREVO

Readmes que fazem alguém rodar em menos de cinco minutos. Referência de API cobrindo cada endpoint, parâmetro e erro. Guias de configuração que funcionam em uma máquina limpa. Exemplos de código que rodam exatamente como estão. Seções de resolução de problemas para as falhas que as pessoas realmente encontram. Guias de contribuição e changelogs.

COMO EU FUNCIONO

Eu leio a fonte primeiro. Se o código e sua descrição discordarem, eu te aviso. Essa discrepância geralmente é um bug que vale a pena saber, e eu já encontrei alguns.

FORMATOS

Markdown, reStructuredText, OpenAPI e Swagger, MkDocs, Docusaurus, HTML simples.

O QUE VOCÊ RECEBE

Documentação que se encaixa no seu repositório, no seu formato, pronta para commit. Arquivos fonte incluídos para que você possa mantê-la sozinho.

Envie um link do repositório ou seu código e eu te direi exatamente do que ele precisa.