Technical Documentation Writer

Project: REST API for Task Management System
Documentation Type: API Reference
Target Audience: Backend developers

Additional context:
- RESTful API with JWT authentication
- CRUD operations for tasks, projects, and users
- Supports pagination, filtering, and sorting
- Returns JSON responses
- Base URL: https://api.taskmanager.com/v1

# Task Management API Documentation

## Overview
The Task Management API provides programmatic access to create, read, update, and delete tasks, projects, and user data. Built on REST principles, it uses standard HTTP response codes, authentication, and returns JSON responses.

### Base URL

### Authentication
All API requests require authentication using JWT tokens:
```bash
curl -H "Authorization: Bearer YOUR_TOKEN" https://api.taskmanager.com/v1/tasks

curl -X GET "https://api.taskmanager.com/v1/tasks?status=pending&limit=10" \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "data": [
    {
      "id": 123,
      "title": "Update documentation",
      "status": "pending",
      "created_at": "2025-01-15T10:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "total_pages": 5,
    "total_items": 48
  }
}

### Advanced Tips:
- **Version control**: Include API versioning strategies
- **Interactive examples**: Suggest tools like Postman collections or Swagger
- **Localization**: Mention if docs need multiple language versions
- **Automation**: Request markdown format for easy integration with doc generators

## Copy-Ready Prompt

## When This Prompt Is Most Useful

Use this prompt when you need help with technical documentation writer but do not want a generic answer. It works best for developers, technical writers, engineering leads, and builders reviewing implementation decisions who already have some context and want the AI to organize it into review notes, rewritten code, test cases, architecture options, or documentation that can be checked by a developer. The prompt is intentionally written to slow the model down: it asks for the goal, missing information, assumptions, reasoning, and a review checklist instead of jumping straight to a polished answer.

This is especially useful when the task has tradeoffs. A simple prompt may produce a confident answer that sounds good but misses constraints. This version makes the model surface those constraints before it gives recommendations, which makes the output easier to edit, verify, and reuse.

## Inputs to Prepare

Before running the prompt, gather:

- The real goal or decision you are trying to support
- The audience, customer, learner, stakeholder, or user involved
- Any source material the AI should use instead of guessing
- Constraints such as deadline, format, budget, word count, platform, or policy
- Examples of good and bad outputs if you have them
- The exact tone you want the final answer to use

For this page, the most important context is: language, framework, repository constraints, target behavior, failing examples, performance limits, and security concerns. If you leave that out, the model may still respond, but the result will usually be generic.

## Example Input

Stack: Next.js and PostgreSQL. Task: review a route handler. Concern: SQL safety, duplicated validation, and missing tests.

## How to Review the Output

Do not use the first answer blindly. Check whether it:

- names concrete failure modes instead of generic best practices
- includes tests or verification steps
- separates security, correctness, and maintainability concerns
- makes assumptions visible instead of hiding them in confident language
- gives you something you can act on, test, or revise within the same work session

If the answer feels generic, reply with: "Make this more specific to my context. Remove generic advice, name the tradeoffs, and show the exact changes you would make." If the answer is too long, ask for a shorter version that keeps the checklist and decision points.

## Common Failure Modes

- **Too little context**: the AI fills gaps with generic advice.
- **No review criteria**: the output sounds polished but is hard to judge.
- **Unclear audience**: the answer may optimize for the wrong reader or use the wrong tone.
- **Overclaiming**: the model may invent certainty when the source material is weak.

The fix is to add concrete inputs and ask for assumptions, alternatives, and review criteria before you use the final output.

## Practical Variations for Technical Documentation Writer

- **Review mode**: Paste the smallest relevant code slice, expected behavior, and known failure. Ask for findings ordered by severity before any rewrite.
- **Implementation mode**: Give the target API, framework constraints, edge cases, and test expectations. Ask for a minimal implementation plan before code.
- **Debugging mode**: Include the error message, reproduction steps, inputs, and recent changes. Ask the model to separate evidence from hypotheses.

## Follow-Up Prompts

Use these after the first answer:

- "Rewrite this using only the context I provided. Label assumptions instead of hiding them."
- "Give me a conservative version, a direct version, and a version optimized for speed."
- "Create a final review checklist I can use before I publish, send, ship, or present this."

## What Makes This Page Different

This page is useful when you are working on technical documentation writer and need more than a blank chat box. It gives you a starting prompt, context checklist, review criteria, and practical variations so the answer can be tested instead of merely accepted. If your task is broader, start with a workflow guide first, then come back to this prompt once the input, audience, and success criteria are clear.