A new developer joins your project, or you hand it to a client. They clone the repo, and nothing tells them how to start. I read your codebase and write the documents that a new developer needs on day one. You get Markdown files that live in the repo, next to the code.
What you get for $59
README: what the project does, the tech stack, and how the folders are organized.
Setup guide: step-by-step instructions to install, run, and test the project on a new machine. I run the steps myself to make sure they work.
Environment-variable notes: each variable, what it does, and where to get its value. I never write the real secret values.
1 revision round on the documents.
Good fit for
Freelance projects that you hand over to a client
Side projects that a new contributor will join
Small team repos with an old or missing README
JavaScript, TypeScript, React, and Node.js projects
How it works
You message me with the repo link and who will read the documents.
I check the size of the repo and confirm the scope.
You give me read access to the repo. I need no production access.
I write the documents, test the setup steps, and send them as a pull request or as files.
You ask for changes, 1 round.
Not included
API reference for every function, architecture diagrams, video walkthroughs, and fixes to the code. I quote these separately. If the setup steps fail because of a bug, I tell you what fails and where.
A new developer joins your project, or you hand it to a client. They clone the repo, and nothing tells them how to start. I read your codebase and write the documents that a new developer needs on day one. You get Markdown files that live in the repo, next to the code.
What you get for $59
README: what the project does, the tech stack, and how the folders are organized.
Setup guide: step-by-step instructions to install, run, and test the project on a new machine. I run the steps myself to make sure they work.
Environment-variable notes: each variable, what it does, and where to get its value. I never write the real secret values.
1 revision round on the documents.
Good fit for
Freelance projects that you hand over to a client
Side projects that a new contributor will join
Small team repos with an old or missing README
JavaScript, TypeScript, React, and Node.js projects
How it works
You message me with the repo link and who will read the documents.
I check the size of the repo and confirm the scope.
You give me read access to the repo. I need no production access.
I write the documents, test the setup steps, and send them as a pull request or as files.
You ask for changes, 1 round.
Not included
API reference for every function, architecture diagrams, video walkthroughs, and fixes to the code. I quote these separately. If the setup steps fail because of a bug, I tell you what fails and where.