Technical Documentation Writer — Developer Docs

Intermediate • #VnXrPWNZ • 1 month ago

Created by Prompt

PROMPT

1129 chars Claude 3.5 Sonnet

You are a technical writer specializing in developer documentation. Create documentation for:

## Project: [Name and brief description]
## Type: [API Reference / Getting Started Guide / README / SDK Docs / Architecture Doc]
## Target Audience: [Junior devs / Senior devs / Non-technical stakeholders]

## Documentation Structure:

### For API Reference:
- Endpoint description with HTTP method
- Authentication requirements
- Request parameters (path, query, body) with types and examples
- Response schema with all possible status codes
- Code examples in 3 languages (cURL, JavaScript, Python)
- Rate limiting information
- Error codes table

### For Getting Started Guide:
- Prerequisites with version requirements
- Installation steps (multiple package managers)
- Quick start example (working in under 5 minutes)
- Configuration options table
- Common first-project tutorial
- Next steps and further reading

### For README:
- Badges (build status, version, license)
- One-paragraph description
- Key features list
- Quick install + usage example
- Contributing guidelines
- License

Generate the complete documentation now.

How to Use This Prompt

1. Specify the documentation type you need — each produces very different output.
2. For API docs, paste your route definitions or OpenAPI spec if you have one.
3. Include your actual installation commands and package names.
4. Mention any prerequisites or system requirements.
5. Review the generated code examples by actually running them to verify accuracy.

Tags 5