Przejdź do treści
Biblioteka skilli
Dokumenty i biuro · Pisanie

public-docs

/public-docs

Tworzy i utrzymuje publiczną dokumentację produktu dla aplikacji packages/docs: tutoriale, koncepcje, referencje, rozwiązywanie problemów, architekturę informacji, frontmatter i linkowanie.

Repozytorium
junior ↗
Licencja
Apache-2.0
Ostatnia zmiana repozytorium
26.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
6
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

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

Licencja

Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.

Co robi i kiedy

Tworzy i utrzymuje publiczną dokumentację produktu dla aplikacji packages/docs: tutoriale, koncepcje, referencje, rozwiązywanie problemów, architekturę informacji, frontmatter i linkowanie.

Oryginalny opis (EN)

Create and maintain public, user-facing product documentation for this repo's `packages/docs` app. Use when asked to write, revise, or review docs pages (tutorial/concept/reference/troubleshooting), improve docs information architecture, fix docs frontmatter/linking issues, or align docs quality with Vercel/Sentry-style standards.

Jak działa

  1. Core invariants
  2. Workflow
Sekcje z nagłówków SKILL.md, w oryginale · 72 linii, 336 słów
Podgląd SKILL.md
---
name: public-docs
description: Create and maintain public, user-facing product documentation for this repo's `packages/docs` app. Use when asked to write, revise, or review docs pages (tutorial/concept/reference/troubleshooting), improve docs information architecture, fix docs frontmatter/linking issues, or align docs quality with Vercel/Sentry-style standards.
---

# Public Docs

Use this workflow to produce docs that are crisp, task-oriented, and trustworthy for external users.

Load only the references needed for the request:

| Task | Read |
|------|------|
| Understand docs app layout and constraints | `references/api-surface.md` |
| Draft or revise common docs pages | `references/common-use-cases.md` |
| Diagnose docs quality/build failures | `references/troubleshooting-workarounds.md` |

## Core invariants

1. Keep docs audience-facing: explain user outcomes, not internal implementation chatter.
2. Match the local docs contract in `packages/docs/src/content/docs/contribute/documentation-guidelines.md`.
3. For new or substantially edited pages, require frontmatter fields: `type`, `summary`, `prerequisites`, `related`.
4. Include concrete verification steps for tutorial/troubleshooting content.
5. End each page with an explicit "next step" path through internal links.
6. Prefer minimal runnable examples over long conceptual exposition.
7. Keep prose present around lists; avoid heading-plus-bullets-only sections.

## Workflow

### 1. Classify the request

Select one primary path:

- New page authoring
- Existing page refactor/clarification
- Information architecture update (sidebar/redirects/navigation)
- Docs quality pass (accuracy, scannability, consistency)
- Troubleshooting/build-fix for docs app

### 2. Gather local context

1. Read `packages/docs/src/content/docs/contribute/documentation-guidelines.md`.
2. Read neighboring docs in the same section (`start-here`, `concepts`, `extend`, `operate`, `reference`, `contribute`).
3. If navigation is involved, read `packages/docs/astro.config.mjs` (`sidebar` and `redirects`).
4. If public interfaces are involved, verify the exported TypeScript surface and its code comments directly.

### 3. Author or edit with the right page shape

1. Pick doc `type` (`conceptual`, `tutorial`, `reference`, `troubleshooting`) from intent.
2. Follow depth and section guidance from documentation guidelines.
3. Keep wording direct and plain; remove filler or internal-only caveats.
4. Use titled code fences for file snippets.
5. Prefer internal links that advance the reader to the next concrete action.

### 4. Validate changes

Run the narrowest meaningful checks:

```bash
pnpm docs:check
```

When structure, sidebar, or redirects change, also run:

```bash
pnpm docs:build
```

### 5. Report completion

Return:

1. Changed files and what each change improves for readers
2. Validation commands executed and outcome
3. Residual risks (for example, missing screenshots, unverified env-specific setup)
Pliki w paczce (6)
  • SKILL.md 3 KB
  • SOURCES.md 1 KB
  • agents/openai.yaml 1 KB
  • references/api-surface.md 2 KB
  • references/common-use-cases.md 2 KB
  • references/troubleshooting-workarounds.md 3 KB

Wersje

W bazie nie ma innych skilli o nazwie public-docs.

Migawka bazy z 13.11.2026 · wersja paczki 07cdc283d071 (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

  • 100docs-review
    Recenzuje dokumentację pod kątem stylu i głosu Sentry, aby tekst dla użytkowników był zgodny z przewodnikiem stylu dokumentacji Sentry.
  • 100update-docs
    Aktualizuje publiczną dokumentację w katalogu docs/public, gdy zmieniają się funkcje albo narzędzia w projekcie.
  • 100tech-writer-researcher
    Pisze i bada dokumentację techniczną: architekturę informacji, przewodniki stylu, dokumentację API, badania użytkowników i strategię treści.
  • 100diataxis
    Strukturyzuje, klasyfikuje i pisze dokumentację według frameworka Diátaxis: README, przewodniki, tutoriale, how-to, referencje API i architekturę dokumentacji.
  • 100kubernetes-docs
    Pisze, przepisuje i audytuje dokumentację Kubernetes i cloud native w niezależnie ujętym stylu dokumentacji Kubernetes: koncepcje, zadania, tutoriale, referencje, konfiguracja i operacje.
  • 100user-docs
    Pisze krótką dokumentację dla użytkowników i deweloperów, skanując ekrany i publiczne API, w standardzie Diátaxis: samouczki, instrukcje, opisy.

Uwagi i zgłoszenia

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