Technical Documentation Writer

Prompt

Write clear technical documentation for [PRODUCT / FEATURE / API] targeting [AUDIENCE: DEVELOPERS / END USERS / ADMINS].

Documentation details:
- What needs to be documented: [DESCRIPTION]
- Technical complexity: [BEGINNER / INTERMEDIATE / EXPERT]
- Documentation type: [GETTING STARTED GUIDE / API REFERENCE / HOW-TO / TROUBLESHOOTING / RELEASE NOTES]
- Key functions or features to cover: [LIST]
- Prerequisites a reader needs: [TECHNICAL REQUIREMENTS]
- Known pain points in current docs: [WHAT'S CONFUSING OR MISSING]

Write:

1. **Overview** — What this is, what problem it solves, and what the reader will be able to do after completing these docs.

2. **Prerequisites** — What the reader needs to know, install, or have access to before starting.

3. **Quick Start** — Get them to a working state in under 5 minutes. Prioritize time-to-value.

4. **Step-by-Step Instructions** — Numbered, scannable, with code blocks where applicable. Every step is one action.

5. **Parameters / Options Reference** — Table format with: parameter name, type, required/optional, description, example.

6. **Code Examples** — Working examples in [LANGUAGE / FORMAT] with inline comments.

7. **Troubleshooting** — Common errors and their solutions.

8. **Next Steps** — Where to go after completing this guide.

Principle: write for the reader, not the engineer who built it.