doc-sync
/doc-sync
Synchronizuje dokumentację go-secs z aktualnym eksportowanym API: poprawia weryfikowalny dryf (błędne sygnatury, zmienione opcje, nieistniejące symbole) i na prośbę przełamuje Godoc semantycznymi liniami.
Ocena i bezpieczeństwo
- Pliki w paczce
- 2
- Skrypty
- 0
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 27.10.2026, bez odwołań do wycofanych modeli i API.
Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.
Co robi i kiedy
Synchronizuje dokumentację go-secs z aktualnym eksportowanym API: poprawia weryfikowalny dryf (błędne sygnatury, zmienione opcje, nieistniejące symbole) i na prośbę przełamuje Godoc semantycznymi liniami.
Oryginalny opis (EN)
Syncs go-secs docs against the current exported API — corrects verifiable drift (wrong signatures, renamed options, phantom symbols, stale behavior), and on request reflows exported Godoc to semantic linefeeds. Use when the user wants docs checked against source, reports doc drift, or asks to reflow Godoc line breaking.
Jak działa
- Procedure (drift)
- Rules (drift)
- Report
Podgląd SKILL.md
--- name: doc-sync description: Syncs go-secs docs against the current exported API — corrects verifiable drift (wrong signatures, renamed options, phantom symbols, stale behavior), and on request reflows exported Godoc to semantic linefeeds. Use when the user wants docs checked against source, reports doc drift, or asks to reflow Godoc line breaking. --- # doc-sync Two modes, picked from the invocation. **drift** is the default when the user does not say. - **drift** — docs reflect current source. Correct factual drift, and leave wording and line breaking exactly as they are. The rest of this file covers it. - **reflow** — rewrite exported Godoc to semantic linefeeds, wording untouched. Runs only when asked. Follow [REFLOW.md](REFLOW.md) instead of the procedure below. Default scope: `README.md`, `sml/README.md`, and `doc.go` of each public package listed in `100-overview.md`. Narrow with an argument. `docs/secs1/*.md` design notes are read-only history — flag only if they misrepresent *current* behavior. ## Procedure (drift) 1. **Inventory source.** For each package in scope, list exported symbols, functional options, and the package-level comment. Do not derive public-API facts from `internal/`. 2. **Inventory docs.** Extract every code block, signature, option name, shortcut constructor (`A`, `I4`, `L`, …), and SEMI-standard reference in the scoped files. 3. **Diff.** For each mismatch, classify: - **stale** — exists but described differently (wrong signature, option, default, behavior). - **missing** — source symbol / option / error / behavior not mentioned. - **phantom** — doc describes something that no longer exists. 4. **Fix.** Targeted edits only. Match signatures verbatim (parameter names, types, variadic). Correct option names everywhere. For phantom symbols, delete the section (and add a one-line "renamed to X" where a replacement exists). For missing symbols, add a stub entry per `400-documentation.md`. 5. **Don't fix** when it requires author intent (ambiguous grammar, design-note decisions, multiple plausible rewordings) — flag as "needs attention." ## Rules (drift) - Read the source file before editing a doc claim. - Verify SML snippets parse under the current parser mode (strict / non-strict). - Don't touch prose tone, section order, or design notes. - Don't fabricate API behavior. If source is ambiguous, quote both the claim and the source. ## Report ``` ## doc-sync report ### Applied - README.md: corrected SendDataMessage signature; added WithValidateDataMessage to the secs1 example. - hsmsss/doc.go: documented exponential-backoff reconnect; added WithLinktestFailureThreshold. ### Needs attention - README.md L300: SML round-trip example ambiguous between strict / non-strict — author input needed. ### No changes - gem/doc.go, logger/doc.go ```
Pliki w paczce (2)
- REFLOW.md 4 KB
- SKILL.md 3 KB
Wersje
| Repozytorium | Wynik | Licencja |
|---|---|---|
| Ta strona · arloliu/go-secs | 100 | Apache-2.0 |
| als-apg/osprey | 100 | BSD-3-Clause |
| JetBrains/ideavim | 100 | MIT |
| cookys/autopilot | 95 | MIT |
| cookys/autopilot | 95 | MIT |
Migawka bazy z 13.11.2026 · wersja paczki cf056373d2cf (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
- 100review-documentation
Przegląda dokumentację: komentarze doc, godoc, komentarze proto, specyfikacje OpenAPI, README i testy przykładowe oraz sprawdza, czy docs są zgodne z kodem. - 100plan-docs-sync
Planuje audyt dokumentacji względem faktycznego działania kodu: wykrywa rozjazdy, nieaktualne README i dokumentację onboardingową opisującą nieistniejące elementy. - 100go-documentation
Podaje konwencje dokumentacji Go: komentarze godoc, dokumentacja pakietu, testowalne funkcje Example, oznaczenia deprecation, linki oraz dokumenty projektu (README, CHANGELOG, llms.txt). - 100docs-audit
Porównuje dokumentację z rzeczywistą implementacją i wskazuje brakujące, zmienione lub błędne API oraz przykłady, z proponowanymi poprawkami. - 90doc-drift
Sprawdza całą dokumentację względem kodu i wskazuje twierdzenia, które przestały być prawdziwe. - 100golang-documentation
Prowadzi dokumentowanie projektów Go: komentarze godoc, README, CONTRIBUTING, CHANGELOG, Go Playground, testy przykładowe, dokumentacja API i llms.txt.