Przejdź do treści
Biblioteka skilli
Projektowanie i UX · Pisanie

dh-component-docs

/dh-component-docs

Pisze dokumentację jednego komponentu na podstawie kodu, stories i realnych miejsc użycia, w tym stanów i zasad użycia.

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

Brak sygnałów. Repozytorium zmienione 09.11.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 dokumentację jednego komponentu na podstawie kodu, stories i realnych miejsc użycia, w tym stanów i zasad użycia.

Wyzwalacze z opisu

document the button\write docs for Select\what states does Toast have\
Oryginalny opis (EN)

Use to write one component's documentation entry from its code, stories and real call sites, such as \"document the button\", \"write docs for Select\", \"what states does Toast have\", or usage rules for a new or changed component. Not for foundations or pages that span components, which no skill here writes, nor for changing the component, which is build-design-system.

Jak działa

  1. Codex packaging notes
  2. Steps
  3. Output
  4. Stops
  5. Rules
  6. Done
Sekcje z nagłówków SKILL.md, w oryginale · 57 linii, 762 słów
Podgląd SKILL.md
---
name: "dh-component-docs"
description: "Use to write one component's documentation entry from its code, stories and real call sites, such as \"document the button\", \"write docs for Select\", \"what states does Toast have\", or usage rules for a new or changed component. Not for foundations or pages that span components, which no skill here writes, nor for changing the component, which is build-design-system."
source_type: "third-party"
source_file: "skills/third-party/design.how/component-docs/SKILL.md"
---

# dh-component-docs

Migrated from `skills/third-party/design.how/component-docs/SKILL.md`.

## Codex packaging notes

- Claude/Telar source files remain the source of truth; this file is the generated Codex adapter.
- Skill-local support files from the original Telar skill, such as `references/...` or `workflow/...`, are packaged beside this `SKILL.md`.
- Repo-root references from the original Telar file, such as `agents/...`, `commands/...`, `scripts/...`, `resources/...`, `rules/...`, `hooks/...`, or `templates/...`, are packaged at this plugin root.
- The original Telar orchestration source (`skills/orchestration/...`) and the vendored third-party source (`skills/third-party/...`) are packaged under `source/skills/...` for exact-reference lookups; all other Telar skills exist here only as the generated adapters under the plugin-root `skills/` directory.
- Resolve plugin-root paths from this generated skill directory via `../..` when reading support files or running packaged scripts.
- This is a vendored third-party skill (pinned copy, MIT) from `design.how`. Provenance, pinned SHA and local modifications are in `third-party/SOURCES.md` of the Telar repository; the license sits at `../../source/skills/third-party/design.how/LICENSE`.
- The body names sibling skills by their upstream names and paths (for example `build-design-system/scripts/capture.mjs`). Resolve those under `../../source/skills/third-party/design.how/`; the generated sibling skills carry a `dd-` / `dh-` prefix.


# Component docs

A draft entry for one component, built only from what its sources say. Gaps are marked, not filled. It does not judge the design and it publishes nothing. The heading order and a worked example are in `references/doc-format.md`.

## Steps

1. Paste the nine headings from `references/doc-format.md` into the draft, empty.
2. Find the component. Read its code, props type, styles and stories, and record each as a Sources line.
3. Find two real uses, by call-site search or from the ask. One real use or none changes the stop table below.
4. Trace which source gave each example, variant, prop, state and token. Every disagreement between sources is a line under Conflicts, with the quoted rule that settles it, or "no rule, not chosen".
5. Fill each section from sourced facts, copying token names and example code character for character.
6. Write Usage rules last. Each rule is `rule/<component>-<slug>`, a condition, an action, a reason, its evidence (two call sites, a measurement with its path, a named principle, or the person's words), and a `Don't:` line with real code that breaks it. A rule you cannot break with a snippet is cut.
7. Fill Guessed at, one line per judgement call. Reread the draft against the Done list below.

## Output

The entry, then Sources, Conflicts, Guessed at, and Gates (a question with its default) only where a rule adds one. Run on its own, it saves to `docs/system/<name>.md` with a draft comment on line 1 and writes each missing example file. The reply opens with the path, what the entry covers and its status, then up to three questions with defaults and one prompt the person can paste to take the next step.

## Stops

| Missing after searching | Why it stops |
|---|---|
| The code | Nothing else sources the variants, props or behaviour |
| The variant list (props type or stories) | A guessed list documents a different component |
| Any use, real or planned | Invented uses read like real ones and readers copy them first |

A props type with no variant prop is an empty list. Variants reads "None" and the run goes on. One real use, planned uses and a deprecated predecessor are marked as such, not stopped on. A stopped run returns the stop, the facts sourced so far by section, and the smallest reply that unblocks it ("one screen name, what put the component there, and which variant showed").

## Rules

- Never write a variant, prop, token name, example or use that has no listed source. A planned use says planned.
- Never invent a state or a precedence order to make a section look complete.
- A behaviour that looks like a bug is written as it is, followed by a `Defect:` line to the owner with what goes wrong for the user and the smallest fix.
- A part also used on its own gets a `### Parts` subsection under Description. A compound component (`Tabs` with `Tab`) is one entry.
- Do not edit the code, stories or spec being documented.
- Counts in the reply come from `grep -o` on the saved file, below the draft comment.

## Done

Every variant, prop, token and example has a Sources line. Every Usage rule has evidence and a `Don't:` line. Every conflict is shown. The nine headings are present in order, and a section with nothing sourced reads `Not applicable: <reason>`.
Pliki w paczce (2)
  • SKILL.md 5 KB
  • references/doc-format.md 5 KB

Wersje

W bazie nie ma innych skilli o nazwie dh-component-docs.

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

  • 100component-docs
    Pisze wpis dokumentacji jednego komponentu na podstawie jego kodu, stories i rzeczywistych użyć: stany, zasady użycia i dostępność.
  • 100write-docs
    Generuje dokumentację custom elements na podstawie manifestu, z przykładami użycia i opisem komponentu.
  • 100component-docs
    Generuje lub aktualizuje dokumentację komponentów z przykładami użycia, tabelami props i stories Storybook.
  • 100generate-component-doc-figma
    Generuje dokumentację Markdown komponentu Figma: anatomia, tokeny, macierz stanów, dostępność, wytyczne treści i opcjonalnie zgodność z kodem.
  • 100design-component
    Projektuje specyfikację komponentu UI: anatomię, warianty, rozmiary, osiem stanów, mapowanie tokenów i dostępność, przed kodem lub równolegle z nim.
  • 100figma-generate-component-doc
    Generuje pełną dokumentację Markdown komponentu Figma: anatomię warstw, tokeny, macierz stanów i wariantów, uwagi o dostępności i wytyczne treści.

Uwagi i zgłoszenia

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