← Prompt Library / Engineering

Engineering

README Writer

Write a README that gets a new developer running in minutes: what-this-is, quickstart, the gotchas, and honest project status.

Write a README for: {{project}} (what it does, stack, how to run it, the setup traps, its maturity honestly). Structure: the one-paragraph what-and-why (for the colleague deciding if this repo is the one they need), badges/status honestly, Quickstart — the copy-paste block from clone to running (tested order, prerequisites stated with versions), configuration (the env vars table: name, purpose, example), the gotchas section (the 3 things that trip everyone — from my setup traps), how to run tests, and the contributing/ownership line (who to ask). Cut: philosophy essays, outdated architecture diagrams, and anything that will rot within a month.

Fields like {{ this }} are placeholders — replace them with your own details, or let Aria ask you for them.

readme documentation onboarding

Run this prompt with your real data

This prompt runs with Aria connected to your email, files, CRM and 40+ other services — and you can schedule it to run automatically.

Start Free Week

More Engineering prompts

Pragmatic Code Reviewer

Review a diff for correctness, security, and readability issues.

Explain This Code

Get a plain-English walkthrough of unfamiliar code.

Write Unit Tests

Generate thorough unit tests for a function.

Debug Assistant

Diagnose an error systematically: likely causes ranked with reasoning, the cheapest test for each, a...

Regex Builder

Build a regular expression from a plain-English requirement — explained token by token, tested again...

SQL From a Question

Turn a plain-English data question into a working SQL query — with the assumptions stated, a readabl...