vamseeachanta Technical Documents (+2)
Technical Documents
Focus areas:
- Accuracy of technical details
- Completeness of procedures
- Clarity for target audience expertise level
- Consistency of terminology
Common issues:
[JARGON]: "Leverage the API endpoint" --> "Use the API endpoint"
[ASSUMPTION]: This assumes reader knows X. Add brief explanation or link.
[MISSING STEP]: Step 3 and 4 have a gap--what happens between them?
Business Documents
Focus areas:
- Clear value proposition
- Supporting evidence for claims
- Professional tone
- Call to action
Common issues:
[VAGUE]: "Significant improvement" --> "23% improvement in processing time"
[PASSIVE]: "Mistakes were made" --> "The team identified three errors"
[WEAK CLOSE]: End with clear next steps or call to action
Marketing Content
Focus areas:
- Audience engagement
- Brand voice consistency
- Compelling narrative
- SEO considerations (if applicable)
Common issues:
[BENEFIT]: Feature stated, but what's the customer benefit?
[PROOF]: Claim needs testimonial, case study, or data
[CTA]: Add clear call to action