I will read your code first, then write the documentation

Most READMEs are written by the person who already knows how the project works, which is exactly the wrong person to write one.

I read your code first, then write the documentation from what it actually does, not from what you remember telling me about it.

What you get:

- A README somebody can follow without asking you a question: what it is, what it needs, how to run it, and what goes wrong first.

- A CHANGELOG that reads like a list of things that are different, not a list of files that changed.

- Setup or API documentation if your project needs it, with the commands tested rather than assumed.

- A note at the end telling you which parts of your code I could not work out, because those are usually the parts your users will not work out either.

What I bring to it: 23 technical guides on my own site, 46 pages in English and Polish, 53,700 words. Nine articles on HackerNoon, one of which reached number one trending and was picked up by the editor's own newsletter.

English or Polish. Send me a repository and tell me who is meant to read it.