technical-writing
/technical-writing
Tworzy README, ADR, opisy API, runbooki i changelogi, gdy trzeba opisać decyzję, interfejs lub procedurę.
- Autor
- swap-cameroon ↗
- Repozytorium
- kuro-antigravity-config ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 11.11.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 1
- Skrypty
- 0
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 11.11.2026, bez odwołań do wycofanych modeli i API.
MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.
Co robi i kiedy
Tworzy README, ADR, opisy API, runbooki i changelogi, gdy trzeba opisać decyzję, interfejs lub procedurę.
Oryginalny opis (EN)
Write clear technical docs: README, ADRs, API docs, runbooks, tutorials, changelogs, onboarding. Use when documenting code, a decision, an API or an operation, or improving unclear documentation.
Jak działa
- Principles
- Templates
- Review checklist
Podgląd SKILL.md
--- name: technical-writing description: "Write clear technical docs: README, ADRs, API docs, runbooks, tutorials, changelogs, onboarding. Use when documenting code, a decision, an API or an operation, or improving unclear documentation." license: MIT metadata: version: "1.0.0" --- # Technical writing Docs are a product with a reader and a job. Name the reader and the job before writing; pick the doc type (Diataxis): **tutorial** (learn by doing), **how-to** (solve a task), **reference** (look up facts), **explanation** (understand why). Do not mix types in one page. ## Principles - Lead with the answer/outcome; prerequisites next; steps after. Short sentences, active voice, one idea per paragraph, consistent terms (build a glossary if the domain needs it). - Every command and snippet must be copy-pasteable and **actually run**; show expected output. Pin versions and OS differences. - Examples over adjectives; a working example is worth a paragraph. - Stale docs are worse than none: keep docs next to code, review them in the same PR, add a "Last verified" date where drift is likely. - Never include secrets or real customer data; use obvious placeholders (`<API_KEY>`). ## Templates **README**: one-line purpose - badges (build, version, license) - quickstart in <5 commands - usage example - configuration table (name, default, description) - architecture link - contributing/testing - support/license. **ADR** (`docs/adr/NNNN-title.md`): Status - Context (forces, constraints) - Decision - Alternatives considered (why rejected) - Consequences (good, bad, follow-ups). Immutable once accepted; supersede with a new ADR. **Runbook**: trigger/alert - impact - prerequisites/access - diagnosis steps with commands and expected output - mitigation/rollback - escalation contacts - verification - post-incident links. Written to be followed at 3 a.m. by someone new. **API reference**: generated from OpenAPI where possible (`api-design`); add task-based guides, auth walkthrough, error catalogue, rate limits, changelog/deprecations. **Changelog / release notes**: user-facing impact first, grouped (Added/Changed/Fixed/Security), link to migration steps for breaking changes (`git-workflow-release`). **Onboarding**: day-1 checklist, local setup verified from a clean machine, who-owns-what, glossary, first good issues. ## Review checklist Right audience and type - answer in the first screen - steps reproducible on a clean environment - no broken links (check them) - no jargon without definition - headings scannable - diagrams as text (Mermaid) so they diff - accessibility: alt text, descriptive link text.
Wersje
| Repozytorium | Wynik | Licencja |
|---|---|---|
| Ta strona · swap-cameroon/kuro-antigravity-config | 100 | MIT |
| ericrisco/rsc-harness | 100 | MIT |
| sma1lboy/rove | 100 | MIT |
| Calvin-LLC/skills | 100 | MIT |
| chmonitor/chmonitor | 100 | GPL-3.0 |
| KyaniteHQ/threadsift | 100 | AGPL-3.0 |
| asarelcastellanos/claude-workbench | 100 | MIT |
| guangshinhaha/shinstack | 100 | MIT |
| valsteen/pinboard | 100 | MIT |
Migawka bazy z 13.11.2026 · wersja paczki 4bdce4aca9cf (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
- 100agent-technical-writer
Specjalizuje się w dokumentacji technicznej: Architecture Decision Records, dokumentacja API, przewodniki migracji, runbooki i bazy wiedzy. - 90Technical Writing
Pisze dokumentację techniczną: ADR, RFC, README, referencje API, poradniki, runbooki i notatki o wydaniach oraz sprawdza ich poprawność. - 100documentation-patterns
Podaje wzorce dokumentacji technicznej: README, ADR, changelogi, API w OpenAPI 3.1 i styl pisania przy tworzeniu dokumentacji projektu. - 100documentation
Pisze i utrzymuje dokumentację techniczną: README, runbooki, przewodniki wdrożeniowe, dokumentację API, architektury i operacyjną. - 100technical-documentation
Prowadzi zestaw dokumentacji projektu: README, architekturę, decyzje ADR, referencję API i aktualizacje statusu po każdej sesji. - 90technical-documentation
Tworzy, utrzymuje i audytuje dokumentację techniczną: pliki README, ADR, dokumentację API, runbooki i pliki kontekstu dla agentów.