ZoeZOE

Quick Project README

Free

Workflow · productivity

A free two-step tour of how workflows work — produces a respectable README for any project.

2 steps1 installs

What this workflow does

A two-step teaser workflow that demonstrates how Orbit workflows work. Sage gathers context about your project through a short clarifying interview, then Ink writes the README from the gathered notes. Free recipe — when you don't own the referenced personas, the smart-upsell flow runs and you can add Sage + Ink piecemeal or as a bundle. The output is a respectable README for any project; the real value is the format demo.

OutcomeA polished README.md tailored to your project, plus a working demo of how Orbit workflows feel end-to-end.

Step by step

2 steps · handoff between 2 personas
sage
RESEARCHER
Step 1 of 2

Gather context

Simple

Persona: Sage — the researcher who finds the buried lead. Skill in play: research-synthesizer

What this step does

Runs a short, structured interview with the user to gather the 6-8 facts a good README needs. Sage doesn''t just ask — Sage probes when an answer is too vague, fills in obvious context from the repo when accessible, and produces a structured note doc that''s the input for Ink in step 2.

Expected inputs

  • A repo URL, a directory listing, or just the user''s description of the project

Walk (the 6-question interview)

  1. What does this project do, in one sentence? (push back if it''s buzzword soup)
  2. Who is it for? (developers, end-users, internal team — be specific)
  3. What''s the install or quick-start command? (copy-paste ready)
  4. What''s the simplest "hello world" usage? (the demo example)
  5. What''s the project''s status? (alpha, beta, prod, deprecated)
  6. What goes in the contributing / license / acknowledgments? (or skip)

If the agent can read the repo, it should pre-fill what it can (package.json name/version, license file, common scripts) and confirm with the user instead of asking blind.

Output handoff to step 2

A structured note doc with these 6 fields filled in plus any "additional context" Ink should keep in mind (project tone, audience expertise level, must-not-include items).

Expected output: A structured note doc with: project description, audience, install command, hello-world example, status, contribution/license info.
Skills used:research-synthesizer
ink
WRITER
Step 2 of 2

Write the README

Simple

Persona: Ink — the writer who makes technical content readable. Skill in play: content-repurposer

What this step does

Turns Sage''s structured notes into a README that''s actually readable. Picks the right tone for the audience, uses copy-paste-ready examples, follows the README convention developers expect (so they can scan it in 30 seconds and find what they need).

Expected inputs

  • Sage''s structured note doc from step 1

Walk

  1. Lead with the one-sentence description (Sage''s answer to Q1, polished)
  2. Add badges if appropriate (build, version, license — but only if real, never fake)
  3. Sections in this order: Overview → Quick start → Usage → Configuration → Contributing → License
  4. Code blocks for every command and example, fenced with the right language tag
  5. No filler. No "powerful" or "blazing fast" unless those are measurable claims
  6. End with a one-line "see also / related" if there''s a docs site

Output

A complete README.md as a single copy-pasteable block, ready to drop into the repo.

Expected output: A complete README.md ready to commit: overview, quick start, usage, configuration, contributing, license sections.
Skills used:content-repurposer

How to invoke

  • ›Run the quick-project-readme workflow on this repo
  • ›Walk me through the workflow tour and write me a README for my project
  • ›Use quick-project-readme to draft a fresh README from scratch