RateMyPrompt

RateMyPrompt

Discover and share the best AI prompts, rated by AI & humans

Self-Correcting Technical Writer

Self-correcting technical writing system with systematic review, error detection, and iterative improvement

8.0/10Overall
8.0AI
No user ratings
Technical Documentation
Full
For: Claude 4, GPT-4.1 - Technical documentation and user guides1 views
Submitted Jul 18AI evaluated Jul 18

Prompt

<initial_draft>
Let me create an initial draft of the technical documentation for: {topic}

{First_attempt_at_technical_writing}
</initial_draft>

<self_review_checklist>
Now let me critically review my draft:

**Clarity and Comprehension:**
- Is the language clear and jargon-free where possible?
- Are complex concepts explained with examples?
- Would a newcomer understand this?
Issues found: {clarity_issues}

**Technical Accuracy:**
- Are all technical details correct?
- Are code examples functional and tested?
- Are there any misleading statements?
Issues found: {accuracy_issues}

**Completeness:**
- Have I covered all essential aspects?
- Are there missing prerequisites or dependencies?
- Do I need more examples or use cases?
Issues found: {completeness_issues}

**Structure and Flow:**
- Does the information follow a logical sequence?
- Are sections properly organized?
- Do transitions between topics make sense?
Issues found: {structure_issues}

**Audience Appropriateness:**
- Is the content at the right technical level?
- Have I considered different user scenarios?
- Are assumptions about prior knowledge stated?
Issues found: {audience_issues}
</self_review_checklist>

<revision_plan>
Based on my self-review, here's what needs improvement:

Priority 1 (Critical): {critical_issues_to_fix}
Priority 2 (Important): {important_improvements}
Priority 3 (Nice to have): {optional_enhancements}
</revision_plan>

<corrected_version>
Here's my improved version addressing all identified issues:

{Revised_and_improved_technical_documentation}

**Verification Notes:**
- Technical accuracy verified: {verification_steps}
- Clarity tested with: {clarity_testing}
- Completeness confirmed: {completeness_check}
</corrected_version>

<final_quality_check>
Final review of corrected version:
- Does this solve the original documentation need? ✓/✗
- Is it clear, accurate, and complete? ✓/✗
- Would I be confident sharing this with the team? ✓/✗

If any checks fail, here's what still needs work:
{remaining_issues_if_any}
</final_quality_check>

AI Evaluation

How we evaluate
Claude 3 Haiku
AI Evaluation
7.8/10
GPT-4 Mini
AI Evaluation
8.3/10

User Rating

No ratings yet. Be the first to rate!

Rate this prompt
Your 5-star rating is doubled to match our 10-point scale for fair comparison with AI scores.