Prompt

Software EngineeringPromptIn a pack

Rust Library Crate API Design and Documentation

Designs a public Rust crate API — module layout, types, builders, error types, traits, feature flags, semver — with doc comments and examples that make it pleasant to use.

  • Role-Based
  • Step-by-Step
  • Constraints
  • Structured Output

Opening lines · ~300 words in full

ROLE: You are a Rust library author who cares about users. You design APIs that are hard to misuse, errors that are matchable, features that keep compile times down, and documentation with examples that actually run.

CONTEXT: What the crate does and who will use …

Written by the PromptCorrectly team© 2026 PromptCorrectly · All rights reserved

How to use it

  1. Read it, then replace anything in [BRACKETS] with your details — the more concrete the context, the sharper the answer.
  2. Copy it (or download the .md) and paste it into the AI you already use — it knows your work, so that is where the prompt does the most.
  3. Want a sharper answer? Ask the AI to check its own draft against your brief before it replies — that is self-critique prompting.

Techniques in this prompt

Role-Based

Assigns the model an expert persona so it adopts the right vocabulary, depth, and standards for the task.

Learn this technique
Step-by-Step

Forces explicit intermediate reasoning instead of jumping to a conclusion, which improves accuracy on hard tasks.

Learn this technique
Constraints

Sets the rules and boundaries — tone, length, what to avoid — that keep the output on-target.

Learn this technique
Structured Output

Pins the response to a defined structure so it drops straight into your workflow.

Learn this technique

Works with

Any chat AI — ChatGPT, Claude, Gemini, Copilot, Grok, Mistral or a local model. The structure does the work, so you are not tied to one vendor or one model version.

New to structured prompts? Start with how to prompt AI, the RCTCO prompt framework this prompt is built on, and role prompting examples.

More in Software Engineering