Context

• Sample type: Content critique using a scorecard
• Product: Vector storage application on a unified enterprise AI/ML platform
• Users: Data scientists, data engineers, and business analysts
• Content being critiqued: User guide
• Audience: Technical writer who authored the user guide

Approach

• I co-developed a scorecard to provide feedback to technical writers and content designers
• I used the scorecard to provide feedback to a technical writer new to developing simple, lean, user-centered content

Rationale

• Some teammates were not following our new content guidelines
• Increasingly, due to limited resources, content was being developed by non-writers as well
• We needed a tool that writers and non-writers could use along with our AI writing assistant and content guidelines to enforce quality
• We needed metrics to see if our content was improving

Outcome

• Detailed analyses of content with actionable feedback
• A way to catch issues early in our own work
• Systematic, consistent assessments for metrics to track over time

Artifact (best viewed on a computer)

Adapted from original