Przejdź do treści
Biblioteka skilli
Programowanie · Pisanie

write-readme

/write-readme

Pisze lub audytuje README projektu, dobiera sekcje do typu projektu i sprawdza linki, nagłówki oraz fragmenty kodu.

Repozytorium
skills ↗
Licencja
MIT
Ostatnia zmiana repozytorium
29.10.2026

Ocena i bezpieczeństwo

100/ 100Klasa: dobry
Format25 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść35 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
3
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 29.10.2026, bez odwołań do wycofanych modeli i API.

Licencja

MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.

Co robi i kiedy

Pisze lub audytuje README projektu, dobiera sekcje do typu projektu i sprawdza linki, nagłówki oraz fragmenty kodu.

Oryginalny opis (EN)

Write or audit a project README. Fixes the section set by project type, front-loads the one-line description and the proof command, then runs the link, heading and snippet checks. Use when asked to write, rewrite, tighten or audit a README, or when a repo has none.

Jak działa

  1. Done
  2. Steps
  3. The two sentences that carry the README
  4. Voice
  5. Report
Sekcje z nagłówków SKILL.md, w oryginale · 42 linii, 617 słów
Podgląd SKILL.md
---
name: write-readme
description: Write or audit a project README. Fixes the section set by project type, front-loads the one-line description and the proof command, then runs the link, heading and snippet checks. Use when asked to write, rewrite, tighten or audit a README, or when a repo has none.
disable-model-invocation: true
---

# write-readme

Write the README that lets a developer start and reproduce one result without reading further.

Rules, section table and check commands: [REFERENCE.md](REFERENCE.md).
Source for each rule and the open gaps: [EVIDENCE.md](EVIDENCE.md).

## Done

1. The section set matches the project type.
2. The proof command runs as written from the first screenful.
3. Every runnable check in REFERENCE.md ran, and the reply names any check that did not.

## Steps

1. **Intake.** Read the manifest, entry points, `bin` field and workspace config. Write down five answers: project type (library, app, CLI, monorepo, documentation repo), audience (user or developer), one sentence on what the project does, the package `description`, the one command that proves it works. Run that command in a clean checkout. Done when five answers are written and the command has produced output.
2. **Pick the section set.** Apply the section table in REFERENCE.md. Mark every section required, optional or skipped, with the reason beside it. Done when the list covers every row of the table.
3. **Write the one-line description.** One line, no heading, under 120 characters, no leading `> `. Match the package `description` and the GitHub repository description word for word. Done when all three strings are identical.
4. **Write the opening.** Sentence one states what it is. Sentence two states why it matters. Then scope and non-scope. Done when a reader who stops after this paragraph knows what the project is, who it serves, and what it leaves out.
5. **Write Install.** Prerequisites first, as its own section, with the literal word None when there are none. Then the exact command. Then the expected output. Done when every prerequisite is named and no step assumes an unstated tool.
6. **Write Usage as one path to one worked result.** Show the real output of each step. Keep the tutorial free of option branches. Done when the result reproduces in a clean environment using only README text.
7. **Document the rest of the surface.** A CLI section when the binary takes subcommands. A configuration table when settings exist. An entry-point example per public API. Troubleshooting ordered symptom, cause, fix. Done when every public surface named in the manifest has one runnable example.
8. **Close with Contributing, then License last.** Contributing names the test command and where to file an issue. License names the license and links the LICENSE file. Done when both sections exist and License is the final section.
9. **Add visuals and badges last.** Alt text decided at insertion. Badges report live state, not a technology list. Done when every image carries alt text and every badge URL resolves to a live status.
10. **Run the checks.** Execute every runnable row of the check table in REFERENCE.md. Fix failures. Done when each row has a recorded result, pass or fail, and the failures are fixed or reported.

## The two sentences that carry the README

- **One line, under 120 characters.** It is mirrored into the package manifest and the repository description. Three copies of one string.
- **One command, above the fold.** It is the reason the reader stays.

## Voice

Concrete over promotional. First sentence carries the point. Headings carry keywords. Front-load the first words of every bullet.

Measured, with its limit: objective wording beat promotional wording by 27% on usability in a 1997 test of websites. Concise beat long by 58%. Scannable beat dense by 47%. All three together beat the control by 124%. Those are 1990s web pages, not READMEs, and the numbers stay attached to that date when quoted.

## Report

Close with what shipped and what could not be checked. Name the failed or skipped check. Leave the judgement of readiness to the human.
Pliki w paczce (3)
  • EVIDENCE.md 5 KB
  • REFERENCE.md 6 KB
  • SKILL.md 4 KB

Wersje

RepozytoriumWynikLicencja
Ta strona · protokol11/skills100MIT
yassimba/loom100Apache-2.0
huangwb8/skills100MIT
devantler-tech/agent-skills95Apache-2.0

Migawka bazy z 13.11.2026 · wersja paczki 963e11e8e3d6 (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 0 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 95readme
    Tworzy lub aktualizuje plik README.md projektu na podstawie jego kodu i dokumentacji.
  • 100readme
    Tworzy lub aktualizuje README projektu: co to jest, jak zainstalować, używać i zbudować, sprawdzone z repozytorium.
  • 100rc-readme
    Pisze lub odświeża README projektu na podstawie dowodów z bazy kodu.
  • 96create-readme
    Generuje lub aktualizuje plik README.md albo CHANGELOG.md projektu.
  • 95github-readme
    Pisze lub przerabia minimalne techniczne README dla projektu lub repozytorium GitHub, opierając się wyłącznie na sprawdzonych faktach.
  • 100readme-writer
    Pisze, przepisuje, przycina lub audytuje README i podobne dokumenty Markdown, sprawdzając linki, polecenia i zgodność wersji językowych.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.