Programowanie · Pisanie
readme-generator
/readme-generator
Tworzy lub przepisuje README.md projektów z myślą o czytelniku, z właściwą strukturą.
- Autor
- serejaris ↗
- Repozytorium
- personal-corp-os ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 21.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
- 4
- Skrypty
- 0
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 0
Przestarzałość
Brak sygnałów. Repozytorium zmienione 21.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
Tworzy lub przepisuje README.md projektów z myślą o czytelniku, z właściwą strukturą.
Wyzwalacze z opisu
write READMEcreate READMEupdate README
Oryginalny opis (EN)
Use when creating or rewriting README.md for projects. Triggers on "write README", "create README", "update README". Creates human-focused documentation with proper structure.
Jak działa
- When to Use
- Process
- Step 1: Research
- Step 2: Analyze Project
- Step 3: Identify Project Type
- Step 4: README Structure
- Writing Style
- Related Skills Section
- Quick Reference
- Common Mistakes
Sekcje z nagłówków SKILL.md, w oryginale · 202 linii, 721 słów
Podgląd SKILL.md
---
name: readme-generator
description: Use when creating or rewriting README.md for projects. Triggers on "write README", "create README", "update README". Creates human-focused documentation with proper structure.
---
# README Generator
Generate human-focused README files following current best practices.
**Core principle:** README is for humans, not agents. Research → Analyze → Write.
**Model recommendation:** Use `Task` tool with `model: haiku` for README generation — faster and cheaper for documentation tasks.
## When to Use
- Creating README for new project
- Rewriting outdated README
- User asks "write/create/update README"
## Process
```dot
digraph readme_flow {
rankdir=TB;
"1. Research best practices via Exa" [shape=box];
"2. Analyze project structure" [shape=box];
"3. Identify project type" [shape=diamond];
"4. Write README with appropriate sections" [shape=box];
"5. Commit and push if requested" [shape=box];
"1. Research best practices via Exa" -> "2. Analyze project structure";
"2. Analyze project structure" -> "3. Identify project type";
"3. Identify project type" -> "4. Write README with appropriate sections";
"4. Write README with appropriate sections" -> "5. Commit and push if requested";
}
```
## Step 1: Research
**Always search first** for current README best practices:
```
mcp__exa__web_search_exa: "best practices README.md {year} {project_type}"
```
Look for:
- Current trends in README structure
- Examples from similar projects
- What sections are essential vs optional
## Step 2: Analyze Project
Read these files to understand the project:
- `CLAUDE.md` or existing docs
- `package.json` / `pyproject.toml` / `Cargo.toml`
- Main entry points
- Test files (understand features)
## Step 3: Identify Project Type
| Type | Key Sections |
|------|--------------|
| **CLI Tool** | Usage examples, Options table, Installation |
| **Library/SDK** | API overview, Quick start, Examples |
| **Web App** | Features, Quick start, Architecture diagram |
| **Full-stack** | Architecture, Quick start both parts, Tech stack |
| **AI/ML** | Model info, Requirements (GPU), Examples |
## Step 4: README Structure
**Essential (all projects):**
```markdown
# Project Name
**One-line value proposition.**
Brief description (2-3 sentences max).
## What It Does / Features
- Bullet points of capabilities
- Focus on VALUE not implementation
## Quick Start
Minimal steps to get running (< 5 commands)
## Requirements
- Runtime versions
- System requirements
- Disk space if significant
## Usage
Examples for common cases
## Tech Stack (if non-trivial)
Table format preferred
## License
```
**Optional by project type:**
| Section | When to Include |
|---------|-----------------|
| Architecture diagram | Web apps, full-stack, complex systems |
| Project Structure | Open source, contribution expected |
| API Reference | Libraries, SDKs (or link to docs) |
| Related Skills | If Claude Code skills exist |
| CLI Options table | CLI tools |
| Configuration | Apps with config files |
| Known Limitations | If significant gotchas exist |
## Writing Style
**DO:**
- Start with value, not implementation
- Use active voice
- Keep sentences short
- Include runnable examples
- Write for humans scanning quickly
**DON'T:**
- Include API reference for internal use
- Write walls of text
- Use jargon without explanation
- Include every possible option
## Related Skills Section
If project has Claude Code skills, add:
```markdown
## Related Skills
| Skill | Trigger | What it does |
|-------|---------|--------------|
| `skill-name` | "trigger phrase" | Brief description |
```
## Quick Reference
| Project has... | Include |
|----------------|---------|
| Web UI | Screenshot or architecture |
| CLI | Options table, examples |
| API | Endpoint summary (not full docs) |
| AI/ML | Model, hardware requirements |
| Claude skills | Related Skills table |
| Complex arch | Mermaid diagram |
## Common Mistakes
| Mistake | Fix |
|---------|-----|
| API docs dump | Link to separate file or remove |
| No quick start | Add "clone → run" in < 5 steps |
| Wall of text | Use bullets, tables, code blocks |
| Missing requirements | Always list runtime + system reqs |
| Generic description | Start with specific value prop |
## Example Structure (Full-stack App)
```markdown
# Project Name
**Value proposition in one line.**
Brief description.
## Features
- Feature 1
- Feature 2
## Quick Start
\`\`\`bash
./start.sh
\`\`\`
## Requirements
- OS/hardware
- Runtime versions
## Tech Stack
| Layer | Stack |
|-------|-------|
## Architecture
\`\`\`mermaid
flowchart...
\`\`\`
## Project Structure
\`\`\`
project/
├── ...
\`\`\`
## Related Skills
| Skill | Trigger | Description |
## Development
How to test, build
## License
```
Pliki w paczce (4)
- README.md 2 KB
- README.ru.md 3 KB
- SKILL.md 5 KB
- assets/illustration.png 456 KB
Wersje
| Repozytorium | Wynik | Licencja |
|---|---|---|
| Ta strona · serejaris/personal-corp-os | 100 | MIT |
| jeremylongshore/tons-of-skills-marketplace | 100 | MIT |
| jeremylongshore/tons-of-skills-marketplace | 100 | MIT |
| dexter826/readme-generator | 100 | MIT |
| dainch/my-skills | 100 | MIT |
| wedsamuel1230/embedded-engineering-skills | 100 | MIT |
| SkillMedev/skills | 100 | MIT |
| anchildress1/awesome-ai | 100 | MIT |
| ArabelaTso/Skills-4-SE | 100 | Apache-2.0 |
Migawka bazy z 13.11.2026 · wersja paczki d29eca4d24cb (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 2 · 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. - 90dev-loop-readme-writer
Pisze i porządkuje pliki README projektów open source, ze strukturą i dokumentacją projektu. - 100readme-generator-free
Generuje README, dokumentację instalacji i użycia oraz odznaki dla projektu na podstawie istniejącego kodu. - 90create-readme
Tworzy plik README.md dla nowego repozytorium lub przy jego braku, analizując dokumentację i strukturę katalogów projektu. - 96create-readme
Generuje lub aktualizuje plik README.md albo CHANGELOG.md projektu. - 100readme-writing
Tworzy, przepisuje lub znacząco poprawia README na podstawie rzeczywistej struktury repozytorium, poleceń i odbiorców.