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

75%

Does it follow best practices?

Impact

100%

1.14x

Average score across 1 eval scenario

Securityby

Passed

No findings from the security scan

Fix and improve this skill with Tessl

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

Evaluation results

100%

13%

Add Docstrings to a Retry Utility Module

Docstrings with intent for retry/backoff module

Criteria

Without this skill

With this skill

Args section present

80%

100%

Returns section present

80%

100%

Usage example present

50%

100%

Helper docstring Args

75%

100%

Helper docstring Returns

71%

100%

Thundering herd mentioned

100%

Jitter intent documented

100%

Why not What — retry logic

100%

No logic changed

100%

All functions documented

100%

Repository: HoangNguyen0403/agent-skills-standard
Path: .github/skills/common/common-documentation/SKILL.md
Commit: 9a54312

Evaluated: 2 months ago
Agent: Claude Code
Model: Claude Sonnet 4.6

Table of Contents

Add Docstrings to a Retry Utility Module

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.