CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

doc-generator

تولید مستندات جامع و دقیق API از کد منبع. برای ایجاد یا به‌روزرسانی مستندات API، تولید مشخصات OpenAPI، یا وقتی کاربر از مستندات API، endpointها یا مستندسازی حرف می‌زند استفاده کنید.

Quality

75%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./fa/03-skills/doc-generator/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

55%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

The content delivers a genuinely useful, executable endpoint-documentation template, but it is output-shaped rather than process-shaped: there is no workflow for going from source code to finished docs, no validation step, and no guidance for the OpenAPI spec output it promises. A version/date/model metadata footer wastes tokens.

Suggestions

Add a step-by-step workflow: analyze source code to enumerate endpoints → extract parameters/response shapes → generate docs using the template → validate the OpenAPI spec (e.g., with a linter) → verify examples match actual code behavior.

Remove the metadata footer (last-updated date, Claude Code version, compatible models list) — it is time-sensitive token waste that will go stale and does not help execute the task.

Include a minimal OpenAPI/Swagger spec example or the tool/command used to generate it, since it is the skill's headline output but currently has no concrete guidance.

DimensionReasoningScore

Conciseness

The core is lean (output list plus a concrete template), but the footer carries time-sensitive metadata — "آخرین به‌روزرسانی: ۴ اوت ۲۰۲۶", "نسخه Claude Code: 2.1.220", and an 11-model "مدل‌های سازگار" list — that is not in a deprecated/old-patterns section and earns no tokens. Mostly efficient with a padded metadata block, matching anchor 3 rather than 4.

3 / 5

Actionability

The per-endpoint template is copy-paste ready: a parameter table, JSON 200/404 response bodies, and executable cURL/JavaScript/Python examples. Not 5 because the headline output — OpenAPI/Swagger specs — has no example, format, or command, and no guidance exists for the source-code analysis step.

4 / 5

Workflow Clarity

No process is described at all: there are no steps for analyzing the source code, extracting endpoints, generating the docs, or validating output (e.g., linting the OpenAPI spec). This sits between anchor 1 (steps missing) and anchor 3 (steps listed with validation gaps) — an implied rough sequence exists via the template, but with major gaps and no validation, so 2 fits best.

2 / 5

Progressive Disclosure

Single-file skill with no bundle directories; sections are clear ("چه چیزی تولید می‌کند", "ساختار مستندات", per-endpoint template) and the template is appropriately the core inline content. Not 5 because the body is ~80 lines and the endpoint template plus output-specific guidance (OpenAPI spec, auth guides, error references) could be split into reference files.

4 / 5

Total

13

/

20

Passed

Description

83%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

A strong description that follows best practices: concrete actions, third-person voice, and an explicit 'use when' clause with natural trigger terms. The only weaknesses are minor — a few missing synonyms (Swagger, SDK) and slight overlap risk with generic documentation skills.

DimensionReasoningScore

Specificity

"تولید مستندات جامع و دقیق API از کد منبع" (generate comprehensive API docs from source code), "ایجاد یا به‌روزرسانی مستندات API" (create/update API docs), and "تولید مشخصات OpenAPI" (generate OpenAPI specs) list several concrete actions. Not 5 because coverage has gaps (SDK examples, auth guides from the body are absent), not 3 because it goes beyond 1-2 actions.

4 / 5

Completeness

Explicitly answers both: what ("تولید مستندات جامع و دقیق API از کد منبع") and when ("برای ایجاد یا به‌روزرسانی مستندات API، تولید مشخصات OpenAPI، یا وقتی کاربر از مستندات API، endpointها یا مستندسازی حرف می‌زند استفاده کنید"), with concrete trigger phrases. This mirrors the anchor-5 example structure exactly.

5 / 5

Trigger Term Quality

Includes natural terms users would say: "مستندات API" (API documentation), "OpenAPI", "endpointها" (endpoints), "مستندسازی" (documentation). Missing common synonyms like "Swagger", "API spec", or "SDK docs", so it falls just short of comprehensive anchor 5 but clearly above anchor 3.

4 / 5

Distinctiveness Conflict Risk

"API documentation from source code", "OpenAPI specifications", and "endpoints" form a clear niche with distinct triggers and minimal conflict risk. Not 5 because "مستندسازی" (documentation) alone is broad and could overlap with general documentation/README-generation skills.

4 / 5

Total

17

/

20

Passed

Validation

100%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository

luongnv89/claude-howto

Path

fa/03-skills/doc-generator/SKILL.md

Reviewed

Table of Contents

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.