All skills
vercel avatar

/technical-writing

@c358fa9
by vercelvercel/eve5.4k stars
594

Write, edit, review, or audit user-facing documentation for the eve repository. Use for changes under docs/, documentation tied to eve APIs or CLI behavior, docs work based on Slack or support feedback, and requests to make eve docs clearer, more natural, or less AI-patterned while verifying claims against current source, tests, CLI help, public releases, and repository conventions.

Use this Skill: https://skilld.dev/gh/vercel/eve/technical-writing

This session only. Nothing lands on disk.

referencesprose-quality.md

≈813 tokens on demand. Your agent reads this file only when SKILL.md points to it.

Prose quality

Apply this pass after the technical claims and page structure are correct. The goal is clear, natural eve documentation, not a generic rewrite.

Preserve intent

  • Preserve supported meaning, facts, nuance, and necessary uncertainty.
  • Keep established eve terminology even when a synonym would add variety.
  • Leave strong sentences alone. Make the minimum effective edit.
  • Preserve useful detail instead of replacing it with broad summaries.
  • Do not invent examples, measurements, sources, opinions, reactions, or implementation details.
  • Match eve's neutral instructional voice rather than an individual author's casual voice.

Improve clarity

  • Lead with the point when setup adds no necessary context.
  • Prefer concrete nouns and direct verbs over abstractions and inflated claims.
  • Cut repetition, filler, and empty qualifiers without deleting real constraints.
  • Untangle sentences that require rereading, but keep clear long sentences when they carry necessary detail.
  • Vary rhythm only when repeated sentence shapes sound mechanical.

Inspect contextual warning signs

Treat these as warnings, not mechanical bans. Keep an intentional construction when it is the clearest choice or matches repository style.

  • Unsupported importance: Remove claims that something is pivotal, transformative, or broadly significant unless evidence supports the consequence.
  • Promotional language: Replace praise such as seamless, robust, groundbreaking, or powerful with concrete behavior.
  • Superficial analysis: Remove trailing clauses such as “highlighting” or “underscoring” when they do not explain a mechanism or consequence.
  • Vague attribution: Name an authoritative supplied source or remove phrases such as “experts agree” and “studies show.”
  • Stock rhetoric: Remove throat-clearing, faux-insight setups, self-answered questions, decorative contrasts, negative lists, and colon reveals when the following statement works alone.
  • Decorative rhythm: Avoid stacked fragments, forced groups of three, false ranges, repeated sentence templates, and punctuation used only for emphasis.
  • Mechanical diction: Replace fake-strong verbs, synonym cycling, swollen phrases, stacked hedging, and generic AI vocabulary with the precise term.
  • Chatbot artifacts: Remove canned praise, offers to continue, knowledge-cutoff disclaimers, and “I hope this helps” language.
  • Weak endings: End on the last useful fact or next action instead of a redundant summary, slogan, metaphor, or “In conclusion” paragraph.
  • Decorative formatting: Remove scattered emphasis, unnecessary micro-headings, and lists that are clearer as short prose.

Final read

Read the changed section in full, then check:

  1. Every claim still matches its source.
  2. The revision preserves the original intent and necessary uncertainty.
  3. Each sentence contributes information, reasoning, or a necessary transition.
  4. The prose sounds direct and natural when read aloud.
  5. The edit did not normalize unrelated or already-clear writing.

For a review-only request, report concise findings with a clickable file and line. Do not assign an AI score or claim to know whether AI wrote the text.

Source: SKILL.md on GitHub

No alerts1mo3 checks · Risk SAFE
  • Gen Agent Trust Hub1mo

    This skill provides a comprehensive and secure framework for technical writing, focusing on accuracy, source verification, and clear communication. It incorporates best practices for documentation maintenance and validation.

  • Socket1mo

    No alerts

  • Snyk1mo

    Risk: LOW · No issues

Signed by skilld at c358fa9. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 2 months ago

README badge

README badge for vercel/eve/technical-writing