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

technical-writing-guide

/technical-writing-guide

Układa wyjaśnienia techniczne, raporty i dokumentację tak, by czytelnik najpierw widział wynik, decyzję lub status (BLUF).

Repozytorium
platform ↗
Licencja
MIT
Ostatnia zmiana repozytorium
08.10.2026

Ocena i bezpieczeństwo

90/ 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ść25 / 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 08.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

Układa wyjaśnienia techniczne, raporty i dokumentację tak, by czytelnik najpierw widział wynik, decyzję lub status (BLUF).

Wyzwalacze z opisu

t say
Oryginalny opis (EN)

Use when structuring or rewriting standalone technical explanations, reports, status updates, documentation, recommendations, or operational handoffs so readers see the outcome, decision, action, or status first. Triggers on bottom line up front, BLUF, outcome-first writing, inverted-pyramid structure, concise technical prose, executive summaries, caveat placement, or requests to lead with the answer, even when the user doesn't say 'technical writing'.

Jak działa

  1. Essentials
  2. Gotchas
  3. Progressive Disclosure
Sekcje z nagłówków SKILL.md, w oryginale · 28 linii, 277 słów
Podgląd SKILL.md
---
name: technical-writing-guide
description: "Use when structuring or rewriting standalone technical explanations, reports, status updates, documentation, recommendations, or operational handoffs so readers see the outcome, decision, action, or status first. Triggers on bottom line up front, BLUF, outcome-first writing, inverted-pyramid structure, concise technical prose, executive summaries, caveat placement, or requests to lead with the answer, even when the user doesn't say 'technical writing'."
---

# Technical Writing Guidelines

Structure technical prose so the reader sees what matters before the supporting detail.

Plain prose mechanics are owned by **writing-guide**. Load it with this skill and apply its clarity, terminology, evidence, and concision rules throughout the document.

## Essentials

- **Lead with the reader's need** - Put the outcome, decision, action, answer, or current status first, see [references/outcome-first.md](references/outcome-first.md)
- **Order by consequence** - Follow the lead with implications, decisive caveats, evidence, and background in descending importance, see [references/outcome-first.md](references/outcome-first.md)
- **State uncertainty honestly** - Lead with what is known, what remains unknown, and what evidence or decision comes next, see [references/outcome-first.md](references/outcome-first.md)
- **Preserve technical precision** - Keep exact identifiers, conditions, units, and comparison bases, see [references/technical-precision.md](references/technical-precision.md)

## Gotchas

- Do not add a visible `BLUF` label unless the requested format requires one. The opening sentence carries the bottom line.
- Outcome-first writing does not remove evidence or caveats. Keep a caveat beside the lead when it can change the conclusion.
- Do not invent a decision, owner, deadline, confidence level, or next action. State the gap when the source does not resolve it.
- A tutorial leads with the reader's task or learning outcome. An incident report leads with impact and current status before chronology.
- A specific artifact skill owns required sections and fields. Apply these ordering rules within that structure.
- Do not call prose ASD-STE100 compliant unless the task applies the full controlled vocabulary and grammar standard.

## Progressive Disclosure

- Read [references/outcome-first.md](references/outcome-first.md) - Load when choosing the lead, ordering evidence and caveats, or writing under uncertainty
- Read [references/technical-precision.md](references/technical-precision.md) - Load when preserving identifiers, conditions, units, comparisons, or technical constraints
Pliki w paczce (7)
  • SKILL.md 3 KB
  • SOURCES.md 1 KB
  • eval-queries.json 5 KB
  • evals.json 3 KB
  • moon.yml 1 KB
  • references/outcome-first.md 3 KB
  • references/technical-precision.md 1 KB

Wersje

W bazie nie ma innych skilli o nazwie technical-writing-guide.

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

  • 100pyramid-short-form
    Pisze krótkie teksty z odpowiedzią na początku (mail, memo, streszczenie dla zarządu, BLUF, aktualizacja na Slacku) do około 500 słów według zasady piramidy.
  • 100plain-english
    Zamienia techniczne dowody w jasne, naturalne wyjaśnienia dla użytkownika, zachowując sens, pewność i zobowiązania: podsumowania zmian, raporty błędów, notatki wydania i przekazania.
  • 100executive-writing
    Przekształca notatki i długie wątki w wiadomość dla kierownictwa: najpierw wniosek, jasna prośba i trzy argumenty.
  • 90bluf-rewriter
    Przebudowuje notatkę, mail, aktualizację statusu lub raport tak, by wniosek był na początku, według zasady BLUF, gdy szkic chowa najważniejsze na końcu.
  • 90executive-reporting
    Pisze raporty zmianowe, dzienne, tygodniowe, zarządcze i incydentowe w stylu BLUF, z ryzykiem wyrażonym w kategoriach biznesowych, i zapisuje je.
  • 100technical-docs
    Tworzy lub poprawia dokumentację techniczną dla określonego odbiorcy i zadania, opartą na aktualnej implementacji, np. przewodniki i runbooki.

Uwagi i zgłoszenia

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