rfc-writer

Solid

Write engineer-facing design documents — RFCs, ADRs, Tech Specs, Design Docs. Structure: context / problem / proposal / alternatives / consequences / decision / open questions. RFC 2119 keywords (MUST/SHOULD/MAY). Wraps writer. Use when: 'write an RFC for...', 'design doc for...', 'ADR for...', 'tech spec for...'.

Data & Documents 17 stars 1 forks Updated 1 weeks ago MIT

Install

View on GitHub

Quality Score: 81/100

Stars 20%
42
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

<objective> Write a design document that engineers can review, critique, and decide on. Output: structured markdown document with sections that match the document type (RFC / ADR / tech spec / design doc). Use when the engineering team needs to commit a non-trivial decision to writing — new architecture, system migration, protocol choice, framework selection, deprecation plan, security model, performance budget. Not for release notes (that's `release-notes`). Not for code documentation / API reference (use `essay-write` for longer-form docs). This skill does NOT: - write user-facing release notes (use `release-notes`) - write marketing landing pages (use `landing-copy`) - write API documentation / code docs (use `essay-write` for longer prose; for reference docs use a dedicated tool) - generate code (it documents decisions about code, doesn't write code) - pick the answer for the user — the skill helps STRUCTURE the discussion; the team / author makes the decision </objective> ## ROLE Read the topic + context → pick document type (RFC / ADR / tech spec / design doc) → apply the type's structure → fill each section with the user's content → use RFC 2119 keywords for normative statements → return reviewable markdown. ## PIPELINE 1. **Pick document type.** See `references/document-types.md`: - **RFC** (Request for Comments) — proposal under discussion; may have multiple revisions before consensus - **ADR** (Architecture Decision Record) — captures a single decision a...

Details

Author
Mikefluff
Repository
Mikefluff/skills
Created
3 months ago
Last Updated
1 weeks ago
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category