writing-docs-eval

Community

Quality-focused documentation evaluation.

Authorcjohnhanson
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: writing-docs-eval
Download link: https://github.com/cjohnhanson/codelikecody/archive/main.zip#writing-docs-eval

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.