agentsclimarketplace

Hyperwork tech writing

Skill samrom3/claude-hyper-plugs/hyperloop/skills/hyperwork-tech-writing

Curated Claude Code marketplace and custom plugins by samrom3 for empowering everyday Software Engineers

Install
npx -y skills add samrom3/claude-hyper-plugs --skill hyperwork-tech-writing

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • 1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

Technical writing — READMEs, changelogs, ADRs, docstrings, and user-facing docs. Match repo style, compress prose, preserve structure.

SKILL.md

1.6 KB, as published. Nobody here has run it

Tech Writing

Use: Doc tasks — READMEs, CHANGELOG entries, ADRs, inline docstrings, migration guides.

Approach

  1. Read existing docs in same dir/format first — match voice, structure, heading depth.
  2. Identify audience: user-facing (full sentences, no jargon) vs. agent-consumed (ultra caveman).
  3. Write minimum content that satisfies the task. No padding, no hedging.
  4. Verify all code examples run / match current API.

Compression Rules (agent-consumed files)

  • Drop articles (a/an/the), conjunctions, hedging phrases.
  • Arrows for causality: X → Y.
  • One-line reminders instead of paragraphs for quality criteria.
  • Preserve: numbered steps, code blocks, YAML front-matter, table structure, quoted strings.

Format Rules (user-facing files)

  • Lite compression: drop filler/hedging, keep full sentences.
  • Tables for comparisons. Code blocks for all commands.
  • Keep a Changelog format for CHANGELOG.md: ## [version], ### Added/Changed/Fixed/Removed.

Do / Don't

  • DO: run pre-commit run --all-files — mdformat enforces Markdown style on non-agent files.
  • DO: verify links and file paths exist before writing them.
  • DON'T: add a comment that just restates what the code does.
  • DON'T: document hypothetical future behaviour — only current behaviour.
  • DON'T: leave placeholder text (TODO, TBD, fill in) — write the content or leave the section out.

Keep looking

Skills are one crate of 328,083. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.