agentsclimarketplace
Sign in

Technical writing

Skill Dragoon0x/everything-design-taste/skills/technical-writing

Technical documentation patterns including API docs, developer guides, and reference documentation.From its SKILL.md

Install
npx -y skills add Dragoon0x/everything-design-taste --skill technical-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

  • 9 stars9 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.

SKILL.md

1.1 KB, 199 tokens by cl100k_base, as published. Nobody here has run it

Technical Writing

Documentation Structure

Getting Started (Quickstart)

  • Goal: first success in under 5 minutes.
  • Prerequisites listed upfront.
  • Copy-paste commands that work.
  • Expected output shown.

Guides (How-To)

  • Task-oriented. "How to deploy to production."
  • Step-by-step with numbered instructions.
  • One task per guide.
  • Link to related guides at the end.

Reference

  • Every function/endpoint/parameter documented.
  • Type information, defaults, constraints.
  • Code examples for common use cases.
  • Searchable.

Concepts (Explanation)

  • Why things work the way they do.
  • Architecture decisions.
  • Mental models for understanding the system.

Writing Rules

  • Present tense ("The function returns..." not "The function will return...").
  • Active voice ("Call the API" not "The API should be called").
  • Code examples that compile and run.
  • Version everything. Show which version docs apply to.

What ships with it

Read from the repository

Just SKILL.md. No reference files, no scripts.

Keep looking

Skills are one crate of 325,949. 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.