common-documentation

Write effective code comments, READMEs, and technical documentation following intent-first principles. Use when adding comments, writing docstrings, creating READMEs, or updating any documentation.

1.14x

Quality

77%

Does it follow best practices?

Impact

96%

1.14x

Average score across 3 eval scenarios

Securityby

Passed

No known issues

Fix and improve this skill with Tessl

tessl review fix ./.github/skills/common/common-documentation/SKILL.md

Evaluation results

98%

README Overhaul for an Open-Source Utility Library

README structure with Mission, Onboarding, and Maintenance sections

Criteria

Without context

With context

Mission statement

91%

100%

Prerequisites listed

100%

Installation steps

100%

Usage instructions exact

100%

Inputs/outputs documented

100%

Known quirks documented

100%

Fixes or workarounds

100%

No orphan TODO

100%

No placeholder text

100%

Maintenance section present

75%

97%

Add Documentation to a TypeScript Payment Processing Module

Intent-first comments and JSDoc on TypeScript module

Criteria

Without context

With context

Intent-first inline comments

91%

83%

JSDoc on public members

100%

JSDoc @param tags

100%

JSDoc @returns tag

100%

Usage example in JSDoc

100%

No commented-out code

100%

TODO format with owner

100%

TODO ticket reference

100%

No bare TODO

100%

No what-comments

90%

95%

26%

Design and Document a Notification Service API

OpenAPI spec, Mermaid diagram, and ADR for a new service

Criteria

Without context

With context

OpenAPI/Swagger format

100%

Endpoints documented in spec

100%

Copy-pasteable examples

30%

50%

Mermaid diagram present

100%

ADR file location

100%

ADR contains rationale

100%

Contract-first approach

100%

No bare TODO

100%

Response schema defined

100%

No implementation code

100%

Repository: HoangNguyen0403/agent-skills-standard
Commit: de793e9

Evaluated: about 1 month ago
Agent: Claude Code
Model: Claude Sonnet 4.6

Table of Contents

README Overhaul for an Open-Source Utility Library Add Documentation to a TypeScript Payment Processing Module Design and Document a Notification Service API

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.