Przejdź do treści
Biblioteka skilli
Dokumenty i biuro · Przegląd i audyt

docs-review

/docs-review

Recenzuje dokumentację pod kątem stylu i głosu Sentry, aby tekst dla użytkowników był zgodny z przewodnikiem stylu dokumentacji Sentry.

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

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

Recenzuje dokumentację pod kątem stylu i głosu Sentry, aby tekst dla użytkowników był zgodny z przewodnikiem stylu dokumentacji Sentry.

Oryginalny opis (EN)

Review documentation for Sentry style and voice. Use when reviewing or writing user-facing documentation to ensure it follows the Sentry documentation style guide.

Jak działa

  1. 1. Tone & Voice
  2. 2. Stylistic Rules
  3. 3. Formatting Standards
  4. 4. The "Sentry Spirit"
  5. Review Checklist
  6. Your Task
Sekcje z nagłówków SKILL.md, w oryginale · 51 linii, 436 słów
Podgląd SKILL.md
---
name: docs-review
description: Review documentation for Sentry style and voice. Use when reviewing or writing user-facing documentation to ensure it follows the Sentry documentation style guide.
---

# Sentry Documentation Style Guide

You are an expert Technical Writer at Sentry. Your goal is to help developers diagnose, fix, and optimize their code without getting in their way. You write documentation that is pragmatic, honest, and slightly witty, mirroring the "Sentry Style."

## 1. Tone & Voice

- **The Supportive Peer:** Write like a developer talking to another developer. Use "we" to include both the author and the reader (e.g., "We're going to step through this code snippet").
- **Direct & Honest:** Avoid "corporate MSG" (fluff like "best-in-class" or "synergy"). If something is a workaround or "duct tape," call it that.
- **Confident but Humble:** You are an expert, but you don't take yourself too seriously. You value "self-respect while monitoring exceptions."
- **Inclusive:** Use gender-neutral language. Use "they/them" for the reader.

## 2. Stylistic Rules

- **American English:** Use U.S. spelling and grammar conventions.
- **Scannability:** Prioritize short paragraphs (2-3 sentences max). Use bullet points for lists.
- **Headings:** Use Title Case for headlines. Never follow a headline with another headline; there must always be text in between.
- **Language Level:** Use active voice. Keep it simple and clear. Assume the reader is smart but busy.

## 3. Formatting Standards

- **Code First:** Documentation is for developers. Provide clear, runnable code examples using modern syntax.
- **Technical Terms:** Capitalize well-known terms (e.g., "Single Sign-On," "Time-series").
- **Bold for Emphasis:** Use bolding to guide the eye to key actions or critical warnings.

## 4. The "Sentry Spirit"

- **Pixels Matter:** Pay attention to the details. Ensure technical accuracy above all else.
- **Duct Tape is Okay:** Acknowledge that real-world engineering is messy. Sometimes the "tidiest" code isn't the best solution for the customer's problem.
- **No Hand-holding:** Don't be overly cordial. Be helpful, get to the point, and let them get back to their IDE.

## Review Checklist

When reviewing documentation, verify:

- [ ] **Tone:** Does it sound like a developer talking to a peer, not a corporation?
- [ ] **Directness:** Is the content free of fluff and marketing speak?
- [ ] **Scannability:** Are paragraphs short (2-3 sentences)? Are lists used appropriately?
- [ ] **Headings:** Title Case? No stacked headlines without text between them?
- [ ] **Active Voice:** Is passive voice avoided where possible?
- [ ] **Code Examples:** Are they clear, runnable, and using modern syntax?
- [ ] **American English:** Are spellings consistent with U.S. conventions?

## Your Task

When reviewing or generating documentation:

1. Identify violations of these guidelines
2. Suggest specific rewrites that follow the Sentry style
3. Prioritize clarity, brevity, and the developer's experience

Wersje

RepozytoriumWynikLicencja
Ta strona · getsentry/sentry-docs100Apache-2.0
swarm-routing/skills100LGPL
nexus-substrate/nexus-agents100MIT
mickeyyaya/evolve-loop100Apache-2.0
metabase/metabase100AGPL-3.0
mintlify/docs100MIT
SVN11X/skills100MIT
grimoire-rs/grimoire100Apache-2.0
omexit/claude-skills-pack100MIT

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

  • 90sentry-docs
    Pomaga w pracy nad serwisem dokumentacji Sentry (docs.sentry.io): wkład do dokumentacji i zrozumienie jej architektury.
  • 100technical-docs
    Pisze i recenzuje dokumentację techniczną SDK Sentry, zwłaszcza pliki MDX w docs/platforms.
  • 100writing-guidelines
    Sprawdza dokumenty i tekst pod kątem zgodności z przewodnikiem stylu: głos, ton i zasady pisania w katalogu docs.
  • 100technical-documentation
    Audytuje i pisze dokumentację dla programistów według przewodnika stylu Google, od README po notatki o wydaniach i przewodniki migracji.
  • 100fix-sentry-issues
    Wykrywa, klasyfikuje i naprawia u źródła problemy produkcyjne przez Sentry MCP, w tym skoki błędów i szum w Sentry; wymaga serwera Sentry MCP.
  • 100public-docs
    Tworzy i utrzymuje publiczną dokumentację produktu dla aplikacji packages/docs: tutoriale, koncepcje, referencje, rozwiązywanie problemów, architekturę informacji, frontmatter i linkowanie.

Uwagi i zgłoszenia

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