Eu vou ler seu código primeiro, depois escrever a documentação

Algumas informações foram traduzidas automaticamente.

Polônia

Eu falo Polonês, Inglês, Alemão

1 pedido finalizado

Desenvolvedor Python, aplicativos desktop para Windows, ferramentas de IA

Eu crio softwares desktop para Windows em Python, e entrego eles. PC Workman é meu: um monitor de sistema com um assistente de IA local e offline que explica o que sua máquina está fazendo. Está na Mi...

Saiba mais

Sobre este Serviço

A maioria dos README são escritos pela pessoa que já sabe como o projeto funciona, o que é exatamente a pessoa errada para escrever um.

Eu leio seu código primeiro, depois escrevo a documentação com base no que ele realmente faz, não no que você lembra de ter me contado sobre ele.

O que você vai receber:

- Um README que alguém consegue seguir sem te perguntar: o que é, o que precisa, como rodar e o que dá errado primeiro.

- Um CHANGELOG que parece uma lista de coisas diferentes, não uma lista de arquivos que mudaram.

- Documentação de setup ou API, se seu projeto precisar, com comandos testados e não apenas assumidos.

- Uma nota no final dizendo quais partes do seu código eu não consegui entender, porque geralmente são as partes que seus usuários também não vão entender.

O que eu trago para isso: 23 guias técnicos no meu próprio site, 46 páginas em inglês e polonês, 53.700 palavras. Nove artigos no HackerNoon, um deles chegou ao número um de tendências e foi divulgado na newsletter do próprio editor.

Inglês ou polonês. Me envie um repositório e diga quem deve lê-lo.

Saiba mais