Przejdź do treści
Biblioteka skilli
Programowanie · Pisanie

readme-docs

/readme-docs

Tworzy lub odświeża README jako stronę wejściową dla nowych osób, z celem projektu, dowodami, przykładami i nawigacją po dokumentacji.

Repozytorium
vosslab-skills ↗
Licencja
MIT
Ostatnia zmiana repozytorium
22.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
7
Skrypty
0
Komentarze HTML
2
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 22.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 sprawdzić przed instalacją
  • SKILL.md zawiera komentarze HTML (2). Nie widać ich w podglądzie Markdown, a model je czyta.

Co robi i kiedy

Tworzy lub odświeża README jako stronę wejściową dla nowych osób, z celem projektu, dowodami, przykładami i nawigacją po dokumentacji.

Oryginalny opis (EN)

Create or refresh a distinctive, evidence-backed `README.md` landing page for newcomers. Use when a README is missing, thin, generic, stale, or hard to navigate. Covers purpose, audience, first success, proof, examples, and documentation routes.

Jak działa

  1. Purpose
  2. Route supporting resources
  3. Landing-page contract
  4. Workflow
  5. Managed visuals
  6. Content boundary
  7. Completion
Sekcje z nagłówków SKILL.md, w oryginale · 84 linii, 571 słów
Podgląd SKILL.md
---
name: readme-docs
description: "Create or refresh a distinctive, evidence-backed `README.md` landing page for newcomers. Use when a README is missing, thin, generic, stale, or hard to navigate. Covers purpose, audience, first success, proof, examples, and documentation routes."
---

# README landing page

## Purpose

Make `README.md` a useful front door: establish identity, audience, value, proof, first success, and
deeper documentation routes in the order a newcomer needs them. This skill owns README content;
specialized documentation skills own their files under `docs/`.

## Route supporting resources

- Start from [`assets/README_TEMPLATE.md`](assets/README_TEMPLATE.md) for a missing, thin, or
  structurally failed README.
- Read [`references/readme_best_practices.md`](references/readme_best_practices.md) when project type
  or section choice is unclear.
- Read [`references/landing_page_ideas.md`](references/landing_page_ideas.md) when the page needs a
  stronger signature promise or proof treatment.
- Apply [`references/review_checklist.md`](references/review_checklist.md) for broad refreshes and
  final landing-page audits.
- Apply [`references/scoring_rubric.md`](references/scoring_rubric.md) for explicit scoring,
  before/after comparison, or a broad refresh.

Resolve every template placeholder before delivery.

## Landing-page contract

- Use one H1 for the project name, followed by a plain-prose opening paragraph of at most 250
  characters. State purpose, audience or use case, main benefit, and a distinguishing detail when
  space allows. Put links, badges, code, URLs, and setup after that paragraph.
- Establish purpose and the strongest available proof before `Quick start`.
- Give a verified install/run path that reaches a meaningful result, plus one representative example
  and expected behavior when useful.
- Summarize three to six concrete capabilities or outcomes and curate three to eight primary
  documentation routes before grouping a larger docset.
- Include supported status, limitations, prerequisites, platforms, help, license, citation, or
  contributor routes only when repository evidence makes them useful.
- Preserve current explanations, examples, visuals, warnings, and credits that remain accurate.

## Workflow

1. Read operative repository rules, the current README, core docs, manifests, executable front
   doors, examples, tests, screenshots, release/deployment evidence, and license files.
2. Derive the project name, audience, primary value, project type, first-success path, strongest
   proof, and adoption constraints from current evidence.
3. For a broad refresh, score the current page and identify the two highest-value improvements.
4. Design the newcomer journey: identity and value, proof, first success, representative use,
   deeper routes, then secondary adoption context.
5. Write a project-specific opening and choose a live demo, screenshot, output sample, compact
   transformation, architecture visual, or worked scenario that proves the signature promise.
6. Verify every command that is safe and practical. Match paths, claims, live links, deployment
   URLs, status, and license wording to repository evidence.
7. Apply the routed review checklist, repository Markdown/ASCII checks, and
   `tests/test_readme_first_paragraph.py` when present. Re-score broad refreshes.

## Managed visuals

When the project has a visual interface/output or the user requests screenshots, include this exact
empty block for `screenshot-docs`:

```markdown
<!-- screenshots:begin (managed by screenshot-docs) -->
<!-- screenshots:end -->
```

This skill owns surrounding prose and the sentinel lines. `screenshot-docs` owns capture,
`docs/screenshots/`, alt text, embed syntax, and the content between sentinels.

For a browser app, place a confirmed live link near the opening. Use a configured URL; derive a
Pages URL only when deployment evidence confirms it.

## Content boundary

Keep the value proposition, primary onboarding path, representative example, and navigation context
in README. Route exhaustive APIs, configuration, architecture, troubleshooting, and maintainer
process to their owning docs. Turn substantive missing docs and remaining landing-page opportunities
into bounded follow-ups with an owner, target, evidence, success criteria, and verification.

## Completion

Return the updated README, commands and links checked, unresolved claim status, and routed doc gaps.
For broad refreshes, include before/after scoring and the strongest gain. Finish only when the quick
start reaches a real result, the page carries project-specific proof when applicable, all placeholders
are resolved, and current valuable content remains discoverable.
Pliki w paczce (7)
  • SKILL.md 5 KB
  • agents/openai.yaml 1 KB
  • assets/README_TEMPLATE.md 3 KB
  • references/landing_page_ideas.md 4 KB
  • references/readme_best_practices.md 10 KB
  • references/review_checklist.md 4 KB
  • references/scoring_rubric.md 6 KB

Wersje

RepozytoriumWynikLicencja
Ta strona · vosslab/vosslab-skills100MIT
rimega92/Engineering-Skills100MIT

Migawka bazy z 13.11.2026 · wersja paczki 99518c2e9992 (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.
  • 95aif-docs
    Generuje i utrzymuje dokumentację projektu: zwięzły README jako stronę wejściową oraz szczegółowe strony tematyczne w skonfigurowanym katalogu docs.
  • 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.
  • 100readme-generator-free
    Generuje README, dokumentację instalacji i użycia oraz odznaki dla projektu na podstawie istniejącego kodu.
  • 100arch-docs
    Tworzy lub odświeża docs/CODE_ARCHITECTURE.md i docs/FILE_STRUCTURE.md na podstawie dowodów z repozytorium, opisując architekturę kodu i układ plików.

Uwagi i zgłoszenia

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