Skip to content
Skills Library
Programming · Review & audit

doc-sync

/doc-sync

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.

Repository
go-secs ↗
Licence
Apache-2.0
Last repository change
27.10.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
2
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 27.10.2026, without references to retired models or APIs.

Licence

Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.

What it does and when to use it

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.

Original author 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.

How it works

  1. Procedure (drift)
  2. Rules (drift)
  3. Report
Original SKILL.md headings · 49 lines, 354 words
SKILL.md preview
---
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
```
Files in this package (2)
  • REFLOW.md 4 KB
  • SKILL.md 3 KB

Versions

RepositoryScoreLicence
This page · arloliu/go-secs100Apache-2.0
als-apg/osprey100BSD-3-Clause
JetBrains/ideavim100MIT
cookys/autopilot95MIT
cookys/autopilot95MIT

Database snapshot: 13.11.2026 · package version cf056373d2cf (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100review-documentation
    Use when the user asks for a documentation review, doc audit, doc comment review, godoc review, proto comment review, OpenAPI or Swagger spec review, README review, example test review, "are the docs in sync with the code", "do the docs still match", "are these comments…
  • 100plan-docs-sync
    Plan-only audit of documentation against actual code behavior. Use when "docs drift", "sync docs with code", "audit documentation", "stale README", "onboarding docs broken", "phantom docs", or "docs out of date". Decisions/ADRs → docs-adr.
  • 100go-documentation
    Go documentation conventions: godoc comments, package docs, testable Example functions, deprecation notices, doc links, and project docs (README, CHANGELOG, llms.txt). Use when: "add godoc", "document this package", "write doc comments", "add examples to docs", "deprecate a…
  • 100docs-audit
    Audit documentation against the real implementation and report drift. Inventories README files, docs folders and public exports, then flags missing APIs, phantom or renamed APIs, contract mismatches, broken snippets and config drift, with proposed unified diffs. Report-only…
  • 90doc-drift
    Use for the whole-estate doc audit, "run the doc-drift loop", "audit the docs against the code", "are the docs still true", "doc drift sweep", "check every doc claim", or a scheduled doc-audit cadence run. NOT for diff-scoped doc sync inside a build cycle (/kit:docs), NOT for…
  • 100golang-documentation
    Comprehensive documentation guide for Golang projects, covering godoc comments, README, CONTRIBUTING, CHANGELOG, Go Playground, Example tests, API docs, and llms.txt. Use when writing or reviewing doc comments, documentation, adding code examples, setting up doc sites, or…

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.