📚 Documentation writer

← Back to marketplace

Writing · Recommended tier: Bee balanced

Inputs

• topicTopicrequired

  Example: How to use the open-bee daemon's plugin system

• audienceAudiencerequired

  Example: engineers new to the codebase | API users | end users

• depthDepthoptional

  Example: quickstart | reference | deep-dive

• contextNotes / contextoptional

  Example: Anything specific the agent should know — links, prior decisions, style guide…

Prompt

The exact instructions Bee receives — modulo your inputs.

Write technical documentation.

Topic: {{topic}}
Audience: {{audience}}
Depth: {{depth}}

Notes / context:
{{context}}

Structure:
1. **What it is** — one paragraph, plain language.
2. **When to use it** — and importantly, when not.
3. **How to use it** — step-by-step with at least 2 code examples.
4. **Common pitfalls** — 3-5 specific things people get wrong.
5. **Related** — link out to anything the reader should know about.

Avoid weasel words. Show, don't tell. Use the present tense.

Run it