Przejdź do treści
Biblioteka skilli
Programowanie · Pisanie

docs-writing

/docs-writing

Pisze i przebudowuje dokumentację, z której czytelnik się uczy, ją wykonuje lub w niej szuka: tutoriale, przewodniki, README, referencje, wyjaśnienia, propozycje, RFC i ADR.

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

Brak sygnałów. Repozytorium zmienione 19.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

Pisze i przebudowuje dokumentację, z której czytelnik się uczy, ją wykonuje lub w niej szuka: tutoriale, przewodniki, README, referencje, wyjaśnienia, propozycje, RFC i ADR.

Oryginalny opis (EN)

Write or restructure documentation such as tutorials, how-to guides, READMEs, reference pages, conceptual explanations, proposals, RFCs, and ADRs, plus explanatory text for slides and diagrams. Use when creating or substantially revising documentation that readers learn from, follow, look up, or decide with, even when the piece is small, such as one reference entry or one caption. Not for interface text (ui-copy), pull request descriptions or release notes (pr-writing), or line editing that keeps a draft's structure (text-editing).

Jak działa

  1. Approach
  2. Gotchas
  3. Finish
Sekcje z nagłówków SKILL.md, w oryginale · 29 linii, 307 słów
Podgląd SKILL.md
---
name: docs-writing
description: Write or restructure documentation such as tutorials, how-to guides, READMEs, reference pages, conceptual explanations, proposals, RFCs, and ADRs, plus explanatory text for slides and diagrams. Use when creating or substantially revising documentation that readers learn from, follow, look up, or decide with, even when the piece is small, such as one reference entry or one caption. Not for interface text (ui-copy), pull request descriptions or release notes (pr-writing), or line editing that keeps a draft's structure (text-editing).
license: MIT
---

# Write documentation

Choose the form by the reader's task, not the publishing platform, and ground every instruction and example in the implementation or supplied specification.

## Approach

Read the reference for the form:

- [Documentation forms](references/documentation.md) for tutorials, how-to guides, reference pages, and explanations.
- [Decision records](references/decisions.md) for proposals, RFCs, and ADRs.
- [Visual content](references/visual-content.md) for slide copy and text that accompanies charts or diagrams. Presentation and design tools handle layout and rendering.

Check existing documentation before adding a page, and update or link useful material instead of duplicating it. Match the reader's knowledge and the project's terminology. Before a section relies on a concept, establish whether the reader already knows it or needs an explanation.

Keep prerequisites before dependent actions and qualifications beside the claims they constrain. Choose the smallest representation that answers the reader's question: prose for reasoning, a table for comparable options, a sequence for ordering, or a shallow tree for responsibility. Show a focused diff when the surrounding shape is familiar, and the complete example when omitted context would hide ownership, order, or a usable result. Place a visual beside the explanation it supports.

## Gotchas

- Familiar words can hide a missing conceptual step. Add that context before shortening the prose.
- An inspected example is not an executed one. Say which you have.
- Supported behavior, proposals, and unknowns read alike unless they are labeled.
- Shortening can drop exact identifiers, version limits, and supporting evidence. Keep them, and explain unfamiliar concepts without weakening their technical meaning.
- Drafting history and unrelated internal process details do not help the reader.

## Finish

Check whether readers can complete the task, locate the fact, or assess the decision. Verify examples and links within the available environment, and report material limits. Leave the rest of the documentation set alone during a narrow edit.
Pliki w paczce (7)
  • LICENSE 1 KB
  • SKILL.md 3 KB
  • agents/openai.yaml 1 KB
  • references/decisions.md 1 KB
  • references/documentation.md 4 KB
  • references/sources.md 2 KB
  • references/visual-content.md 2 KB

Wersje

RepozytoriumWynikLicencja
Ta strona · gustavovalverde/skills100MIT
onyx-dot-app/onyx100MIT
gosuda/dalcom-skills100Apache-2.0
OutlineDriven/outline-driven-development100Apache-2.0
skmtc/skmtc82Apache-2.0

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

  • 100writing-documentation
    Pomaga pisać i porządkować dokumentację techniczną dla ludzi: README, portale, samouczki, przewodniki i referencje API.
  • 100docs
    Pisze lub poprawia dokumentację techniczną pod jedno zadanie czytelnika: README, dokumentację API, instrukcje operacyjne, RFC, dokumenty projektowe, propozycje architektury i ADR.
  • 90Technical Writing
    Pisze dokumentację techniczną: ADR, RFC, README, referencje API, poradniki, runbooki i notatki o wydaniach oraz sprawdza ich poprawność.
  • 100docs
    Pisze i poprawia dokumentację techniczną wokół jednego zadania czytelnika: README, dokumentacja API, instrukcje operacyjne, RFC, dokumenty projektowe produktu, propozycje architektury i ADR.
  • 100documentation
    Tworzy, strukturyzuje i przegląda dokumentację techniczną według frameworka Diátaxis: tutoriale, przewodniki how-to, referencje i strony wyjaśniające.
  • 100absolute-docs
    Pisze, poprawia i audytuje dokumentację dla agentów kodujących według metody Diátaxis: tutoriale, przewodniki, referencje, wyjaśnienia, README i ADR, z weryfikacją każdego twierdzenia wobec kodu.

Uwagi i zgłoszenia

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