readme-docs
/readme-docs
Tworzy lub aktualizuje README projektu według standardu z sekcjami obowiązkowymi, warunkowymi i opcjonalnymi, także po zmianach w kodzie.
- Autor
- rimega92 ↗
- Repozytorium
- Engineering-Skills ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 02.11.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 4
- Skrypty
- 0
- Komentarze HTML
- 1
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 02.11.2026, bez odwołań do wycofanych modeli i API.
MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.
- SKILL.md zawiera komentarze HTML (1). Nie widać ich w podglądzie Markdown, a model je czyta.
Co robi i kiedy
Tworzy lub aktualizuje README projektu według standardu z sekcjami obowiązkowymi, warunkowymi i opcjonalnymi, także po zmianach w kodzie.
Oryginalny opis (EN)
Creates or updates the README.md of a software project (backend, frontend, mobile, library, CLI or anything else) following a documentation standard with mandatory, conditional and optional sections. Use it when the user asks to document a project, create or improve the README, or update the documentation after changing the code.
Jak działa
- Principles
- Create mode
- Update mode
- Pending items
- docs/ files
- Sync marker
- Monorepos
Podgląd SKILL.md
--- name: readme-docs description: Creates or updates the README.md of a software project (backend, frontend, mobile, library, CLI or anything else) following a documentation standard with mandatory, conditional and optional sections. Use it when the user asks to document a project, create or improve the README, or update the documentation after changing the code. --- # readme-docs Generates and maintains a project's `README.md` following the standard in `references/standard.md`. Works with any technology and language. It has two modes: - **Create:** the project has no README, or only a minimal one (just a title or text generated by a template). The README is written in full. - **Update:** a README with real content already exists. Only the sections affected by code changes are modified. If the user names the mode (for example, "create the README from scratch" or "update the README"), use it. Otherwise, choose based on the state of the README. ## Principles - **Everything comes from the project.** Every fact in the README must trace back to a file, a command or an answer from the user. Never invent versions, commands, endpoints, owners or business rules. - **Ask for what the code doesn't say.** Some facts are known only to the team (project status, owners, why a decision was made). Gather these questions and ask them all at once in a single message. Anything left unanswered is marked as pending (see below), never filled in with a guess. - **Proportional to the project.** A small library doesn't need all eight blocks of the standard. Include the `[M]` sections, the `[C]` sections that apply, and only the `[O]` sections that add real value. - **The README is the entry point.** Long content (a full API reference, a detailed data model, long operational procedures) goes in files under `docs/` and is linked from the README (see "`docs/` files"). If a source of truth exists (OpenAPI, database schema, CHANGELOG), link to it instead of copying it. - **Never secrets.** Don't copy values from `.env`, credentials, tokens or internal URLs containing credentials. Document the variable's name, what it's for and a fictitious example value. - **Easy to read.** Plain language in the sections meant for any reader and technical language where a section calls for it, clean Markdown, and clear Mermaid diagrams with color when it helps. Follow `references/style.md` in everything you write. - **Keep the README's language.** If a README already exists, keep its language. For a new one, use the language the user is writing in, unless they ask for another. ## Create mode 1. **Analyze the project.** Go through the folder structure, dependency manifests, scripts, configuration, Docker or infrastructure, CI, tests and entry points. Use `references/evidence-map.md` to see which sections each piece of evidence triggers. 2. **Decide which sections apply.** Go through `references/standard.md`: - `[M]`: always included. - `[C]`: included if you found evidence that they apply. - `[O]`: included only if they add value for this project (for example, a Mermaid diagram when there are several services, or a table of contents when the README is long). - Sections that don't apply are left out, without writing "Not applicable". 3. **Ask for what's missing.** Put all your questions about facts you couldn't infer into a single message. Offer a suggestion when you have one (for example: "Status: active?"). If the user doesn't answer something, carry on and mark it as pending. 4. **Write the README.** Follow the order of the standard's blocks, but use natural headings and group small sections together. The standard defines what gets documented; it doesn't require a heading for every item. Apply `references/style.md` to the wording, formatting and diagrams. 5. **Verify.** - Check that every documented command exists (in `package.json`, `Makefile`, scripts, etc.), that the paths and files mentioned exist, and that internal links work. Don't run commands that install dependencies, deploy or modify data. - Review the Markdown and the diagrams against the checklist in `references/style.md`. If `markdownlint` or `mmdc` is already installed in the project or on the system, use it; don't install either without asking. 6. **Add the sync marker** at the end of the README (see below). 7. **Report** to the user what you created: the sections included, the `docs/` files generated and the list of pending items. ## Update mode 1. **Find out what changed.** - Look for the sync marker at the end of the README. If it exists and the project uses git, review `git diff <commit>..HEAD`, plus uncommitted changes (`git diff HEAD`) and new untracked files. - If there's no marker, ask the user where to start reviewing from (a commit, a base branch or a date). If they don't know, compare the whole README against the current state of the project. - If the user tells you what changed, start there, but confirm it against the code. - Ignore changes to the README itself and to the files in `docs/`: they're the output of the documentation, not the cause. 2. **Map changes to sections.** Use `references/evidence-map.md` to see which sections each modified file affects. A change can make a `[C]` section apply that didn't before (for example, a message queue was added) or make an existing one obsolete. A section can live in the README, in a `docs/` file or in both (a summary in the README and the detail in `docs/`); check both places. 3. **Edit only what's affected.** Change only the affected sections, both in the README and in the `docs/` files the skill maintains. If you change the detail in `docs/`, check that the README summary is still correct, and vice versa. Don't rewrite or restyle the rest. Text written by people is kept as is, unless it contradicts the current code; in that case, correct it and mention it in the report. If a change affects what a diagram shows (a new service, a relationship that no longer exists), update the diagram too. Anything new you write follows `references/style.md`, even if the rest of the README uses a different style. 4. **Don't delete without asking.** If a whole section looks obsolete (for example, it documents a service that no longer exists), propose removing it and wait for confirmation. 5. **Check the `[M]` sections.** If the README is missing a mandatory section, add it even if it's unrelated to the changes. 6. **Verify, update the marker and report**, as in steps 5 to 7 of create mode. In the report, list the sections you modified and the code change behind each one. ## Pending items When a fact that only the team knows is missing, leave a visible marker in its place: ```markdown > **Pending:** add the owning team and the support channel. ``` In update mode, review existing pending items, in the README and in `docs/`, and resolve any you can now complete. ## `docs/` files When a section takes up more than a screen, move it to a file under `docs/` and leave a short summary with a link in the README. Use these names: | File | Content | |---|---| | `docs/architecture.md` | Architecture, components and modules, diagrams, architecture decisions | | `docs/api.md` | Endpoints, integration contracts, authentication, messaging, usage examples | | `docs/data-model.md` | Entities, relationships, database and migrations | | `docs/configuration.md` | Environment variables, per-environment configuration | | `docs/deployment.md` | Deployment, infrastructure, CI/CD | | `docs/operations.md` | Logging and observability, monitoring, operational procedures, troubleshooting | | `docs/development.md` | Testing strategy, coding standards, contribution, debugging | Create only the files you need. Each file: - Starts with a `#` heading and a link back to the README. - Follows `references/style.md`. - Ends with the sync marker. The marker shows that the skill maintains the file. `docs/` files without a marker were written by people. Link to them from the README, but don't modify them. If they contradict the code, flag it in the report. If one of them covers the same ground as a file in the table, ask the user whether the skill may maintain it; if they agree, add the marker and use it instead of creating a new one. ## Sync marker When you finish, add (or replace) this line as the last line of the README and of every `docs/` file you created or modified: ```markdown <!-- readme-docs:sync commit=<short HEAD sha> date=<YYYY-MM-DD> --> ``` If the project doesn't use git, leave out `commit=` and keep only the date. The marker is invisible when the Markdown is rendered. The README's marker tells the next update where to start reviewing changes from; the marker in `docs/` files shows which ones the skill maintains. ## Monorepos If the repository contains several packages or services, the root README gives the overview (purpose, architecture, how to run everything together) and links to each package's README. Each package README follows the same standard, with its own sync marker. Ask the user whether to document all packages or only some.
Pliki w paczce (4)
- SKILL.md 9 KB
- references/evidence-map.md 4 KB
- references/standard.md 9 KB
- references/style.md 8 KB
Wersje
| Repozytorium | Wynik | Licencja |
|---|---|---|
| Ta strona · rimega92/Engineering-Skills | 100 | MIT |
| vosslab/vosslab-skills | 100 | MIT |
Migawka bazy z 13.11.2026 · wersja paczki 0ab2e7b61091 (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. - 90PRD-README v1 Standard
Pisze, poprawia i sprawdza pliki README według standardu PRD-README v1, dbając o jakość dokumentacji i wygodę developerów. - 100project-docs
Tworzy i aktualizuje dokumentację projektu, czyli changelog, dzienniki problemów, README i przewodnik dla klienta po zmianach w kodzie. - 100readme
Generuje lub uzupełnia README z szablonu dopasowanego do typu projektu, a w trybie zmian aktualizuje tylko zmienione sekcje. - 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.