跳到正文
cccskills
免费在 GitHub 公开

rfc-writer

Write well-structured RFCs with normative clauses. Use when: (1) Creating a new RFC, (2) Adding or editing RFC clauses, (3) User mentions RFC, specification, or normative requirements

中文简介正在准备中。当前显示原文说明。

查看安装方法

包含的文件(1)

  • SKILL.md4.8 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

RFC Writer

Write RFCs that are precise, complete, and follow govctl conventions.

Invocation Mode

This helper skill may be used standalone or by /discuss, /gov, /spec, or /migrate. It is responsible for RFC content and clause quality, not RFC lifecycle verbs. Use /spec or /gov for govctl rfc finalize, bump, or advance.

Quick Reference

govctl rfc new "<title>"
govctl clause new <RFC-ID>:C-<NAME> "<title>" -s "<section>" -k <kind>
govctl clause edit <RFC-ID>:C-<NAME> --stdin <<'EOF'
clause text
EOF

RFC Structure

Every RFC should have:

  1. Summary clause (informative) — what this RFC covers and why
  2. Specification clauses (normative) — the actual requirements
  3. Rationale sections within clauses — why each requirement exists

Summary Clause Template

govctl clause new <RFC-ID>:C-SUMMARY "Summary" -s "Summary" -k informative
govctl clause edit <RFC-ID>:C-SUMMARY --stdin <<'EOF'
Brief overview of what this RFC specifies and why.

**Scope:** What is covered and what is not.

**Rationale:** Why this specification is needed.
EOF

Normative Clause Template

govctl clause new <RFC-ID>:C-<NAME> "<Title>" -s "Specification" -k normative
govctl clause edit <RFC-ID>:C-<NAME> --stdin <<'EOF'
The system MUST ...
The system SHOULD ...
The system MAY ...

**Rationale:**
Why this requirement exists.
EOF

Writing Rules

RFC 2119 Keywords

Use these keywords in ALL CAPS in normative clauses:

KeywordMeaning
MUSTAbsolute requirement
MUST NOTAbsolute prohibition
SHOULDRecommended but not required
SHOULD NOTDiscouraged but not prohibited
MAYOptional

Quality Checklist

  • Be specific. Avoid vague terms: "appropriate", "reasonable", "as needed". Say exactly what.
  • Include rationale. Every normative clause should explain why, not just what.
  • One requirement per sentence. Don't chain MUST/SHOULD in a single sentence.
  • Reference existing artifacts. Use [[RFC-NNNN]] or [[ADR-NNNN]] syntax.
  • Testable. Each MUST/SHOULD should be verifiable — if you can't test it, rewrite it.

Clause Naming

  • Use C- prefix followed by a descriptive uppercase name with hyphens
  • Good: C-VALIDATION, C-ERROR-FORMAT, C-WORK-DEF
  • Bad: C-1, C-Misc, C-stuff

Section Types

SectionClause KindContent
SummaryinformativeOverview, scope, rationale
SpecificationnormativeMUST/SHOULD/MAY requirements
RationaleinformativeExtended explanation

Rendering Rules

The renderer auto-generates structural elements. Do NOT include these in clause text:

  • Clause heading (### [RFC-XXXX:C-NAME] Title) — auto-generated from metadata
  • *Since: vX.Y.Z* — auto-generated from the since JSON field
  • > **Superseded by:** ... — auto-generated from the superseded_by field
  • Amended: ... — does not exist; do not hallucinate this

Clause text should contain only the specification prose, rationale, and [[...]] references.

Common Mistakes

MistakeFix
Vague MUST: "MUST handle errors appropriately"Specific: "MUST return Result<T, E> with descriptive error message"
No rationaleAdd **Rationale:** section explaining why
Untestable requirementRewrite so it can be verified programmatically
Missing cross-referencesAdd [[RFC-NNNN]] or [[ADR-NNNN]] links
Including Since: in clause textDon't — the renderer adds it from the since field automatically
Including clause heading in textDon't — the renderer generates ### [RFC:C-NAME] Title from metadata

Validation and Handoff

  • Run govctl check after substantive RFC edits
  • Use rfc-reviewer before lifecycle handoff
  • Use /spec for clarification-only or artifact-only RFC maintenance
  • Use /gov for implementation-bearing RFC amendments

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Write effective Architecture Decision Records. Use when: (1) Creating a new ADR, (2) Recording a design decision, (3) User mentions ADR, decision, trade-off, or alternatives

中文简介正在准备中。当前显示原文说明。

lucifer1004/typub352026年7月11日 更新

commit

免费

Commit changes with govctl integration — check work item status, update journal or notes, and run govctl check

中文简介正在准备中。当前显示原文说明。

lucifer1004/typub352026年7月11日 更新

Stress-test a design decision with premortem/backcast analysis, then produce a risk-calibrated recommendation that maps to ADR fields. Use when: (1) Multiple competing architecture options, (2) Irreversible or high-risk design choices, (3) /discuss identifies a complex trade-off

中文简介正在准备中。当前显示原文说明。

lucifer1004/typub352026年7月11日 更新

discuss

免费

Facilitate design discussion — research context, clarify requirements, draft RFC/ADR

中文简介正在准备中。当前显示原文说明。

lucifer1004/typub352026年7月11日 更新

gov

免费

Execute governed implementation workflow with work items, RFC/ADR checks, phase gates, testing, and closure. Use when: (1) User invokes /gov, (2) A non-trivial change needs work item tracking, (3) Implementation may require RFC/ADR handling

中文简介正在准备中。当前显示原文说明。

lucifer1004/typub352026年7月11日 更新

Write well-structured Verification Guards. Use when: (1) Creating a new guard, (2) Editing guard check commands or patterns, (3) User mentions guard, verification, or check

中文简介正在准备中。当前显示原文说明。

lucifer1004/typub352026年7月11日 更新

查看 lucifer1004 的全部技能

报告此技能的问题