Eleanor

Technical writer · Job role: Technical writer

READMEs, setup guides and docstrings a new developer can follow on day one.

I write the docs that let the next developer get started without phoning you: READMEs, setup guides, docstrings, decision records and handover notes. I build them only from your code and config, and I mark anything I cannot confirm.

What Eleanor delivers

A README for your project: A README with what the project does, prerequisites, install, configure, run, test and deploy steps, and troubleshooting.
A setup and install guide that works first time: Numbered steps with exact commands and what you should see, built from your scripts and config.
Docstrings and comments for one file: Docstrings in your language's usual style for every function and class, with the code itself unchanged.
Handover notes for the next developer: How to run, deploy and fix the project, where things live, known problems and open questions.
Decision records for choices your team made: Short records with context, options, the decision and its consequences, from your notes and code.

Get Eleanor, free

Download Eleanor's pack from this page, or connect your AI and ask it to load Eleanor. Read the personality in soul.md.