readme-skeleton

oleh AgentsRoomDiverifikasi AgentsRoomBelum ada pemasanganBelum ada sukaDiperbarui 7 Mei 2026Kategori: Rekayasa

Apa fungsinya

Use when adding a README to a project or sub-package. Generates the minimum useful sections without filler.

Pemasangan membuka entri ini di aplikasi desktop AgentsRoom Anda. Jika aplikasinya belum terpasang, Anda akan diarahkan ke halaman unduhan.

SKILL.md

---
name: readme-skeleton
description: Use when adding a README to a project or sub-package. Generates the minimum useful sections without filler.
---

# README skeleton

When asked to add or rewrite a README, produce these sections in this order:

1. **One-liner** — what does this thing do, in 12 words max.
2. **Quick start** — exact commands to clone + install + run + see it working.
3. **Configuration** — required env vars, with examples and what happens when missing.
4. **Project structure** — only if non-obvious; one paragraph max.
5. **Contributing** — branch convention, test command, PR review expectation.

Skip: marketing fluff, badges nobody clicks, screenshots that go stale, history.

Tag

docs

Bacaan lanjutan

Claude Ads: skill Claude Code yang mengaudit akun iklanmu

Claude Ads adalah skill open source untuk Claude Code: 250+ pemeriksaan di Google, Meta, LinkedIn, TikTok, atau Amazon Ads, skor dari 100, dan rencana aksi berprioritas dalam sekitar sepuluh menit. Instalasi, perintah, batasan, dan cara mengorkestrasinya di AgentsRoom.

AGENTS.md: Satu File Konteks untuk Semua Coding Agent (Codex, Antigravity, Claude)

AGENTS.md adalah file instruksi portabel yang dibaca coding agent AI kamu sebelum menyentuh kodemu. Apa saja yang perlu ditaruh di dalamnya, bedanya dengan CLAUDE.md, dan cara menjaga satu konteks tetap konsisten di Codex, Antigravity, dan Claude.