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

Content

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 clear, organized guidance for writing docs-site content. Its main weaknesses are moderate verbosity (some guidance restates things Claude already knows about good writing), lack of concrete before/after examples or templates that would make it more actionable, and a workflow that's implicit rather than explicitly sequenced with validation checkpoints.

Suggestions

Add a concrete before/after example showing a poorly-written docs page transformed into one following these guidelines, making the skill more actionable.

Trim sections that restate general writing best practices Claude already knows (e.g., 'Put prerequisites before steps', 'Define terms before using them') and focus on project-specific conventions.

Make the workflow more explicit by numbering the full process (inspect → draft → format → review checklist) in a single 'Workflow' section at the top, with the review checklist serving as an explicit validation gate.

Consider providing a minimal page template (skeleton markdown) for each page type (user, developer, solution) to give Claude a concrete starting point.

DimensionReasoningScore

Conciseness

The skill is reasonably well-organized but includes some verbose sections that could be tightened. Phrases like 'Absorb the current site voice first, then improve structure and readability without making the page feel like it came from a different documentation system' are somewhat padded. Several sections explain concepts Claude already understands (e.g., what admonitions are, general writing advice like 'put prerequisites before steps'). However, it's not egregiously verbose.

2 / 3

Actionability

The skill provides concrete guidance on structure, tone, and formatting patterns (e.g., specific admonition types, page ordering, heading examples), but lacks executable code or copy-paste-ready templates. The guidance is specific enough to act on but remains largely instructional prose rather than concrete examples of actual page output or before/after comparisons.

2 / 3

Workflow Clarity

There is a clear implied workflow: inspect nearby pages → draft following the structure order → apply writing rules → run review checklist. However, the sequence is spread across multiple sections rather than presented as an explicit numbered workflow. The review checklist at the end serves as a validation step, but there's no explicit feedback loop for revision or error recovery.

2 / 3

Progressive Disclosure

The content is well-sectioned with clear headings that aid scanning, but it's a monolithic single file with no references to supporting documents. Given the length (~150+ lines of guidance covering multiple page types, formatting patterns, and review criteria), some content could be split into separate reference files (e.g., MkDocs patterns, tone guide per section type). However, no bundle files exist, so there's nothing to reference.

2 / 3

Total

8

/

12

Passed

Description

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 clearly identifies when to use the skill with an explicit trigger clause and a specific file path, making it highly distinctive. However, it could benefit from listing more concrete actions beyond 'writing or revising content' and including more natural trigger terms that users might use when requesting documentation help. The second-person 'Use this skill' phrasing is borderline but follows the 'Use when' pattern seen in good examples.

Suggestions

List specific concrete actions such as 'create new pages, update existing guides, add code examples, structure navigation, format tables and admonitions' to improve specificity.

Add natural trigger terms users might say, such as 'documentation', 'markdown', 'write docs', 'help page', 'guide', or '.md files' to improve discoverability.

DimensionReasoningScore

Specificity

Names the domain (App Connect MkDocs site documentation) and some actions ('writing or revising content'), but doesn't list multiple specific concrete actions like 'create tutorials, update API references, format code blocks, add navigation entries'.

2 / 3

Completeness

Explicitly 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 'Use this skill when...' clause is present and specific.

3 / 3

Trigger Term Quality

Includes some relevant keywords like 'docs', 'MkDocs', 'rc-unified-crm-extension', and page types ('user, developer, solution, support pages'), but misses common natural terms users might say like 'documentation', 'write docs', 'update guide', 'help page', or 'markdown'.

2 / 3

Distinctiveness Conflict Risk

Highly distinctive due to the specific directory path ('rc-unified-crm-extension/docs'), the named product ('App Connect MkDocs site'), and the specific page types. This is unlikely to conflict with other documentation or writing skills.

3 / 3

Total

10

/

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.