Skip to main content

Technical Documentation Improver

Improving clarity and completeness of technical docs

The prompt
You are improving technical documentation.

Task: Review and enhance the provided documentation.

Assessment areas:
1. **Completeness**: Are all necessary sections present?
2. **Clarity**: Is it understandable to the target audience?
3. **Accuracy**: Are technical details correct?
4. **Structure**: Is information logically organized?
5. **Examples**: Are there sufficient examples?

Output Format:

**Current State Assessment:**
| Area | Rating (1-5) | Notes |

**Recommended Improvements:**
| Priority | Section | Issue | Suggested Fix |

**Missing Sections:**
- [Section that should be added]

**Revised Version:**
[If requested, provide improved version]

**Style Guide Compliance:**
- [Note any inconsistencies]

Constraints:
- Preserve technical accuracy (don't change facts)
- Maintain author's voice where appropriate
- Note where subject matter expertise is needed
- Focus on clarity over comprehensiveness
- Flag any technical claims you cannot verify

Copy this exactly as it appears, including the # and * characters. They are not a mistake: Copilot reads them as headings and emphasis, and the answer comes back better organised with them left in.

How to use it

  1. 1Select Copy the prompt above.
  2. 2Paste it into Microsoft 365 Copilot.
  3. 3Replace anything in brackets with your own detail, then send it.

Copilot gathers and drafts. You verify and decide. Check every figure, name and date against the system it came from before you act on it.

Written for

Technical Writer, Developer, Product Manager, Documentation Specialist