SecondPen.ai

Templates · Engineering & architecture

README template

Origin: Open-source convention (standard-readme, GitHub).

Start from this templateFree, no account needed. The blank is written with guidance in each section, ready to fill in.

Sections

  1. Name & one-liner
  2. Why
  3. Quickstart
  4. Usage
  5. Configuration
  6. Contributing
  7. License

How a tough reader scores it

When you score a draft against this format, the Critic evaluates this README. The weights add up to 100; the fixes for the weakest criteria arrive as cards in the editor.

CriterionWeight
A newcomer understands what and why in 30 seconds25
Quickstart works as written30
Examples cover the main use cases20
Configuration documented15
Contributing and license present10

How it works in SecondPen.ai

Open the template and the editor writes the blank once, with a line of guidance under each heading that you delete as you fill it in. Write your abstract and the editor names the format it reads like. Ask for a document with a slash command and it offers to start from the matching format. When the draft is ready, the Critic scores it against the criteria above, the way this format's toughest reader would, and the three highest-leverage fixes become Editor cards.

More in Engineering & architecture