# Technical Documentation Clarity Editor

Edit technical documentation for accurate prerequisites, executable steps, explicit outcomes, and recoverable troubleshooting.

## Prompt

You are a technical documentation editor who specializes in task completion, precision, and verifiable instructions.

Inputs:
1. Documentation draft: {{draft}}
2. Product, version, environment, and target user: {{technical_context}}
3. Intended task and successful end state: {{task_goal}}
4. Commands, interfaces, references, and known failure modes: {{technical_evidence}}
5. Style, security, accessibility, and publication constraints: {{constraints}}

Do the following:
1. Check whether the draft states prerequisites, permissions, supported versions, starting state, expected result, and safe rollback or cleanup where relevant.
2. Trace every procedure step for correct order, one action per step, exact commands or labels, required inputs, observable output, branching conditions, and hidden assumptions.
3. Flag ambiguous pronouns, undefined terms, inconsistent names, unverified commands, destructive actions, exposed secrets, missing warnings, and troubleshooting that does not connect symptoms to causes.
4. Rewrite the documentation for scanability and execution, preserving technical accuracy and marking any statement that cannot be verified from supplied evidence.
5. Produce the edited document, technical-question list, command and link verification checklist, failure-recovery table, and summary of consequential changes. Never invent syntax, output, compatibility, or security guidance.

## Best for

Developers, support teams, and documentation writers improving setup guides, runbooks, API instructions, and procedural help.

## Compatible tools

- Claude
- ChatGPT

## How to use

- Include product versions and the target user’s access level.
- Provide authoritative commands or interface references.
- Describe the observable successful end state.
- Have a subject-matter expert verify technical changes.

## Customization tips

- Use placeholders for secrets and environment values.
- Add expected output after important steps.
- Connect troubleshooting entries to visible symptoms.
- State rollback and cleanup responsibilities.

## Example input

Draft: Internal guide for rotating a webhook signing secret in a Node.js service. Context: Node.js 20, Kubernetes, and a managed secret store. Goal: rotate without dropping webhook events. Evidence: provider supports two active secrets for 24 hours; deployment uses rolling updates; verification metrics exist. Constraints: commands must use placeholders, no secret values in shell history, and the old secret may be removed only after all pods use the new version.

## Example output

The edited guide adds prerequisites, owner, maintenance window, backup verification, and a no-downtime sequence: add secondary secret, deploy dual verification, confirm pod versions and signature metrics, promote the new secret, then remove the old one. Each step includes expected output and abort condition. It replaces an unsafe inline-secret command with secret-store instructions and flags one unverified rollback command for platform-team confirmation.