rfc
Draft a lightweight design RFC to docs/rfcs/<slug>.md; Summary, Motivation, Detailed design, Drawbacks, Alternatives, Unresolved questions. A proposal to debate, not a recorded decision (adr).
- License 许可
- MIT
- 最近更新
- 2026-10-29
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- rfc
- description
- Draft a lightweight design RFC to docs/rfcs/<slug>.md; Summary, Motivation, Detailed design, Drawbacks, Alternatives, Unresolved questions. A proposal to debate, not a recorded decision (adr).
02 资源文件 1
- 参考文档routing.yaml345 B
03 SKILL.md 正文
rfc
Lightweight design RFC. Use for changes large enough to need group review but not big enough to need ADR-grade permanence.
Mode: analytical — judgment inside a fixed frame. Keep the output shape; every verdict cites its evidence; unknowns are marked [TBD] or [VERIFY], never filled in.
When to use
- A non-trivial design needs feedback before implementation.
- The user says "let's write an RFC for this".
Inputs
- Title and the change being proposed (required). None: ask; never draft an RFC around an invented change.
- Motivation evidence (optional but expected): incidents, metrics, user reports. Absent: the Motivation section says
[TBD: evidence]and the summary flags the RFC as not ready for review. - Alternatives already discussed and related ADRs/PRDs (optional).
Procedure
- Read
RFC.md. - Slug from the title: a workflow's
${workflow.slug}wins; otherwise lowercase it, replace each run of characters outsidea-z0-9with-, trim-at the ends, and cut to ≤ 60 characters at a-. An existing file at the target path is updated in place (show the diff), never duplicated. - Summary-first checkpoint. Show a one-screen skeleton — the change in one sentence, the motivation evidence, the alternatives you'll compare — and confirm direction before the full draft. Unattended run (workflow step, subagent): nobody can confirm — skip the wait, write the document, and open the summary with the skeleton.
- Draft
docs/rfcs/<slug>.md:- Summary — one paragraph; what changes for callers.
- Motivation — concrete evidence, not "we should probably".
- Detailed design — enough that an implementer can build from it.
- Drawbacks — honest cost; what we commit to maintaining.
- Alternatives — what we considered and why this is the chosen path.
- Unresolved questions — must be resolved before merge or deferred explicitly.
Quality bar
- "Motivation" cites at least one piece of concrete evidence.
- "Drawbacks" is non-empty.
- "Unresolved questions" is present (even if "none").
- ≤ 200 lines total. If it's larger, split into multiple RFCs.
Output
- File:
docs/rfcs/<slug>.md. - Summary listing the open question count.
04 同仓库更多 Skills
runbook
Write or refresh an operational runbook for an alert/symptom; structured as TL;DR + Pre-checks + Steps + Verification + Rollback + Escalation.
editorial-pass
Review and tighten prose in a Markdown artifact for a target tone (terse, formal, friendly) without dropping information; preserve quotations and load-bearing constraints.
architecture-review-facilitation
Run an architecture review as a process — entry criteria, reviewer checklist, decision log, and follow-up actions — pairing the design artifact with a red-team pass.
architecture-doc
Write a C4-style architecture document; System Context + Containers (+ Components when interesting) with mermaid diagrams. Describes structure, not a decision (adr) or proposal (rfc).
adr
Write an Architecture Decision Record (Michael Nygard format) to docs/adrs/NNNN-<slug>.md; frontmatter validated by the ADR artifact schema. Records a made decision, not a proposal to debate (rfc).
triage-vulns
Triage Snyk findings — classify exploitable / reachable / dev-only, propose upgrade or accept-with-justification, never auto-ignore.