CtrlK
BlogDocsLog inGet started
Tessl Logo

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.

74

1.02x
Quality

62%

Does it follow best practices?

Impact

93%

1.02x

Average score across 3 eval scenarios

SecuritybySnyk

Passed

No known issues

Optimize this skill with Tessl

npx tessl skill review --optimize ./.agent-skills/docs-site-writing/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Discovery

75%

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

The description has strong completeness with an explicit 'Use this skill when...' clause and excellent distinctiveness due to the specific project path. However, it could benefit from more concrete action verbs describing what the skill actually does beyond 'writing or revising content', and could include more natural trigger terms users might use when requesting documentation help.

Suggestions

Add more specific concrete actions, e.g., 'Creates new documentation pages, updates existing guides, structures content with proper headings and admonitions, and ensures consistent formatting across the MkDocs site.'

Include additional natural trigger terms users might say, such as 'documentation', 'help pages', 'guides', 'MkDocs', or 'markdown docs'.

DimensionReasoningScore

Specificity

The description names the domain (App Connect MkDocs site documentation) and mentions some actions ('writing or revising content'), but doesn't list multiple specific concrete actions like 'create tutorials, update API references, add troubleshooting guides'. The mention of 'clarity, structure, scannability, and correctness' is somewhat vague.

2 / 3

Completeness

Clearly answers both 'what' (writing/revising content for the App Connect MkDocs site following existing style and best practices) and 'when' ('Use this skill when writing or revising content inside rc-unified-crm-extension/docs'). The explicit 'Use this skill when...' clause provides clear trigger guidance.

3 / 3

Trigger Term Quality

Includes some relevant keywords like 'docs', 'MkDocs', 'rc-unified-crm-extension', 'documentation', and page types ('user, developer, solution, support pages'). However, it's missing common natural terms users might say like 'write docs', 'update documentation', 'help page', or 'README'. The path-based trigger is good but narrow.

2 / 3

Distinctiveness Conflict Risk

The description is highly specific to a particular project ('rc-unified-crm-extension/docs') and a particular documentation site ('App Connect MkDocs site'), making it very unlikely to conflict with other skills. The directory path acts as a strong distinguishing trigger.

3 / 3

Total

10

/

12

Passed

Implementation

50%

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

This is a competent style guide skill that provides useful, specific guidance for writing docs in a particular project's voice. Its main strengths are the clear section-by-section writing rules, the distinction between page types (user/developer/solution), and the review checklist. Its weaknesses are moderate verbosity with some guidance Claude already knows, lack of concrete executable examples (e.g., actual MkDocs Material markup samples or a template page), and a workflow that could be more explicitly sequenced.

Suggestions

Add concrete MkDocs Material syntax examples (e.g., actual admonition markup, card grid syntax, figure syntax) so Claude can copy-paste the correct formatting rather than guessing.

Include a short sample page template showing the recommended structure (title → orientation → core content → caveats → references) with realistic placeholder content.

Trim sections that state general documentation best practices Claude already knows (e.g., 'put prerequisites before steps,' 'define terms before using them') to reduce token usage.

Make the workflow more explicit by numbering the full process from start to finish, including what to do when the review checklist reveals issues.

DimensionReasoningScore

Conciseness

The skill is reasonably well-written but includes some verbose guidance that Claude would already know (e.g., general advice like 'put the reader's likely question first,' 'define terms before using them,' 'keep introductions short'). Several sections could be tightened—the tone/voice guidance repeats similar ideas across multiple sections, and the 'Things to Avoid' list overlaps with earlier guidance.

2 / 3

Actionability

The skill provides concrete structural guidance (page order, admonition types, section naming) and specific examples of good vs. bad headings, but lacks executable examples. There are no code snippets showing actual MkDocs Material syntax for admonitions, card grids, or figures, and no sample page template that could be directly used. The API/interface section describes a preferred order but doesn't show a concrete example page.

2 / 3

Workflow Clarity

There is a clear implied workflow: inspect nearby pages → draft following the structure rules → apply best practices → run review checklist. However, the sequence is not explicitly numbered as a workflow, and the review checklist at the end serves as a validation step but lacks feedback loops (e.g., what to do if the page doesn't match surrounding style). The 'First Step' section is good but the overall process could be more explicitly sequenced.

2 / 3

Progressive Disclosure

The content is well-organized with clear section headings and logical grouping, but it's a fairly long monolithic document (~150 lines) with no references to supporting files. Some sections (like the detailed API/interface guidance or the MkDocs Material patterns) could be split into separate reference files. However, no bundle files exist, so there's nothing to reference. The structure is adequate but not optimally layered.

2 / 3

Total

8

/

12

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.

Validation11 / 11 Passed

Validation for skill structure

No warnings or errors.

Repository
ringcentral/rc-unified-crm-extension
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.