CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

docs-site-writing

Use this skill when writing or revising content inside `rc-unified-crm-extension/docs` for the App Connect MkDocs site. Follow the existing public docs style used across user, developer, solution, and support pages, while applying modern documentation best practices for clarity, structure, scannability, and correctness.

82

1.02x
Quality

80%

Does it follow best practices?

Impact

93%

1.02x

Average score across 3 eval scenarios

SecuritybySnyk

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./.agent-skills/docs-site-writing/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

75%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 body is a well-structured, house-style guide with genuinely repo-specific knowledge (directory conventions, admonition mapping, code-fence rules) and a usable review workflow. Every dimension lands just below the top anchor: minor generic advice, no error-recovery loop around the checklist, and light cross-section redundancy.

Suggestions

Trim "Organic Best Practices" to only the items specific to this docs site — the generic writing principles (prerequisites first, define terms) are things Claude already knows.

Add a feedback loop after the Review Checklist, e.g., "If any item fails, revise that section and re-check before finishing".

Add one short before/after snippet (a vague heading and its scannable rewrite) to make the abstract tone goals ("polished but practical") concrete and copy-paste-able.

DimensionReasoningScore

Conciseness

Compact, well-sectioned bullet guidance with no concept explanations; e.g., "Existing House Style" and "Admonition Guidance" stay terse and domain-specific. Not 5 because "Organic Best Practices" lists generic writing principles Claude already knows ("Put prerequisites before steps", "Define terms before using them repeatedly"), and the opening paragraph repeats the description.

4 / 5

Actionability

For an instruction-only skill the guidance is concrete: per-directory style profiles, a preferred page order, heading do/don't examples ("Authentication" vs "Overview of concepts"), admonition-type mapping, and code-fence consistency rules. Not 5 because some framing is abstract ("polished but practical", "confident without sounding corporate") and there is no example transformation to anchor the style.

4 / 5

Workflow Clarity

A clear sequence exists — inspect 2 to 3 nearby pages, match the local section style, write/revise, then verify against the "Review Checklist" before finishing. Not 5 because there is no feedback loop telling Claude what to do when a checklist item fails, and the first step's "when possible" weakens the entry point.

4 / 5

Progressive Disclosure

A single well-organized file with no nested or buried references, and no content that clearly belongs in a separate file. Not 5 because the skill exceeds the simple-skill threshold with some redundancy across "Things to Avoid", "Admonition Guidance", and "MkDocs Material Patterns" that tightening or splitting could resolve.

4 / 5

Total

16

/

20

Passed

Description

75%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 solid description with an explicit trigger clause, a concrete target directory, and good natural keyword coverage. It sits between the 4 and 5 anchors on every dimension: everything is present and specific, but the capability statement leans on style-matching language and omits common synonyms a user might say.

Suggestions

List the concrete actions Claude performs (e.g., "Write, restructure, and polish user, developer, solution, and support pages") before the style guidance, so the 'what' reads as deliverables rather than manner.

Add one or two user-sayable synonyms to the trigger clause, such as "when editing, updating, or reviewing pages in the docs site".

Name the deliverable explicitly (a page on the App Connect MkDocs site) so the description distinguishes document *creation* from style advice alone.

DimensionReasoningScore

Specificity

"writing or revising content inside `rc-unified-crm-extension/docs`" and "Follow the existing public docs style used across user, developer, solution, and support pages" name several concrete actions scoped to a real target. Not 5 because "applying modern documentation best practices for clarity, structure, scannability, and correctness" is generic rather than a specific action.

4 / 5

Completeness

Explicit "Use this skill when writing or revising content inside `rc-unified-crm-extension/docs` for the App Connect MkDocs site" answers 'when' concretely, and the what/when pair is complete. Not 5 because the 'what' ("Follow the existing public docs style... while applying modern documentation best practices") describes manner more than deliverables and lacks broader user-sayable trigger phrases.

4 / 5

Trigger Term Quality

Includes natural trigger words users would say — "writing", "revising", "docs", "App Connect MkDocs site", plus the page-type names (user, developer, solution, support). Not 5 because common synonyms like "edit", "update", "guide", or "documentation page" are missing.

4 / 5

Distinctiveness Conflict Risk

Scoped to one repo's public MkDocs docs site and clearly separated from the monorepo's internal `docs/` folder, giving it a distinct niche. Not 5 because a generic request like "improve this documentation" could still overlap with general technical-writing skills.

4 / 5

Total

16

/

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

ringcentral/rc-unified-crm-extension

Path

.agent-skills/docs-site-writing/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.