writing-docs-eval

Evaluate technical documentation using IBM DQTI, Diátaxis, and EPPO principles.

Updated Feb 28, 2026
One-click install
npx skills add https://github.com/cjohnhanson/codelikecody --skill writing-docs-eval
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: writing-docs-eval
Source: https://github.com/cjohnhanson/codelikecody/tree/main/skills/writing-docs-eval
Command: npx skills add https://github.com/cjohnhanson/codelikecody --skill writing-docs-eval

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation quality is often inconsistent across projects and frameworks; this Skill provides a repeatable method to evaluate technical docs using IBM DQTI, Diátaxis per-type criteria, and Baker's Every Page is Page One principles.

Core Features & Use Cases

  • Framework-aligned evaluation: applies IBM DQTI nine characteristics, Diátaxis type criteria, and EPPO principles in one cohesive review.
  • Actionable findings: identifies gaps in clarity, completeness, accuracy, and organization with concrete remediation suggestions.
  • Use Case: perform pre-release audits of API references or user guides to ensure they meet high-quality standards before publication.

Quick Start

Run a full evaluation on your documentation set to generate a quality report.

Frequently Asked Questions about writing-docs-eval

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I evaluate technical documentation quality before publication?▼

Documentation quality evaluation applies IBM DQTI nine characteristics, Diátaxis per-type quality criteria, and Baker's Every Page is Page One principles to produce a structured report with actionable findings for technical docs.

What is the best way to perform a pre-release audit of API references and user guides?▼

The best way to perform a pre-release audit of API references is to run a framework-aligned evaluation that identifies gaps in clarity, completeness, accuracy, and organization, providing concrete remediation suggestions.

Can I use Diátaxis and EPPO principles together to review design docs?▼

Yes, you can use Diátaxis and EPPO principles together to review design docs. This method applies Diátaxis per-type quality criteria and Baker's Every Page is Page One principles cohesively to ensure technical documentation meets high-quality standards.

Does this documentation review process provide actionable findings for gaps in clarity?▼

Yes, the documentation review process provides actionable findings for gaps in clarity. It identifies specific gaps in clarity, completeness, accuracy, and organization, producing a structured report with concrete remediation suggestions to fix them.

When do I need to use IBM DQTI nine characteristics for a docs-review?▼

You need to use IBM DQTI nine characteristics for a docs-review when documentation quality is inconsistent across projects. Applying these characteristics provides a repeatable method to evaluate technical docs during audits and pre-publication checks.