CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

content-proofreading

An academic proofreading skill for Chinese/English manuscripts, triggered when you need automated checks for spelling, grammar, terminology consistency, and formatting before submission.

Quality

71%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Low

Low-risk findings worth noting

Fix and improve this skill with Tessl

tessl review fix ./scientific-skills/Other/content-proofreading/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

56%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 clear, verified CLI workflow with an explicit output-validation step, but is padded with a duplicated features section and ~80 lines of overlapping boilerplate guardrails, and its Python API example does not match the bundled code. Moving implementation details into reference files and trimming the duplication would meaningfully improve it.

Suggestions

Delete the 'Key Features' section (it restates Steps 3–5 almost verbatim) and consolidate 'When Not to Use', 'Required Inputs', 'Output Contract', 'Failure Handling', 'User Checkpoints', 'Input Validation', and 'Quick Validation' into one short section — they repeat the same guardrails several times.

Fix the Python module example to match the bundled API: AnnotationGenerator takes no constructor arguments and exposes to_html/to_markdown (no .generate() method); also either add the missing requirements.txt or remove the 'pip install -r requirements.txt' instruction.

Move the terminology/rule database formats and module-by-module 'Implementation Details' into a reference file (e.g., references/architecture.md) and link to it and to assets/terminology/biology.json so the SKILL.md body stays a lean overview.

DimensionReasoningScore

Conciseness

The ~70-line 'Key Features' section restates the Agent Workflow almost verbatim (e.g., 'Spelling (including US/UK variants)', 'Typo/misused character detection (dictionary-based)' duplicate Steps 3–5), and five overlapping boilerplate sections (~80 lines: 'When Not to Use', 'Required Inputs', 'Output Contract', 'Failure Handling', 'User Checkpoints', 'Input Validation', 'Quick Validation') repeat the same guardrails — e.g., 'Do not proceed without user confirmation' vs. 'Before executing batch processing ... confirm scope and output format with the user'. This matches 'noticeably verbose; several unnecessary explanations or padded sections' rather than merely 'some unnecessary explanation' (3), though it never explains concepts Claude already knows (1).

2 / 5

Actionability

The CLI guidance is fully executable and matches the actual bundle: 'python scripts/init_run.py --input <paper_file_path> --output <output_path>' with a parameter table (--lang/--style/--terminology/--format/--no-pdf) verified against init_run.py's argparse, plus working install commands. It falls short of 5 because the Python example is not executable against the bundled code — 'AnnotationGenerator(output_format="html")' and 'generator.generate(results)' do not match the actual no-arg __init__ or its to_html/to_markdown methods, and requirements.txt (referenced in 'pip install -r requirements.txt') is absent from the bundle.

4 / 5

Workflow Clarity

Steps 1–7 are clearly sequenced with concrete tool calls ('call EnglishChecker().check(text)', 'Feed all findings to AnnotationGenerator') and an explicit validation checkpoint — 'Step 7: Validate Output: Verify all detected issues have location + type + fix'. It is not a 5 because there is no explicit fix-and-retry feedback loop after validation fails; 'Failure Handling' gives recovery guidance ('Report the failing step, likely cause, and recovery suggestions') but it is generic rather than a loop wired into the workflow.

4 / 5

Progressive Disclosure

The body has clear section structure but inlines content that belongs in separate reference files — the ~70-line 'Implementation Details' with 'Terminology database format (JSON)' and 'Rule database format (JSON)' examples — and never links to the existing bundle (scripts/, assets/terminology/biology.json) for navigation. It also references paths that don't exist in the bundle ('requirements.txt', 'assets/rules/'). This matches 'some structure but ... references present but not clearly signaled; content that should be separate is inline'.

3 / 5

Total

13

/

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 that states concrete capabilities in third person and includes an explicit trigger clause. Its main weaknesses are a slightly generic 'when' clause and missing natural synonyms/file-type triggers.

DimensionReasoningScore

Specificity

The description lists several concrete actions — 'automated checks for spelling, grammar, terminology consistency, and formatting' — each a specific capability rather than vague language. It falls short of a 5 because coverage has gaps: the skill also handles reference-style validation (APA/MLA/GB/T 7714) and report generation, which the description omits.

4 / 5

Completeness

Both 'what' and 'when' are explicitly stated: what — 'An academic proofreading skill for Chinese/English manuscripts' with enumerated checks; when — 'triggered when you need automated checks ... before submission'. It is not a 5 because the trigger clause is somewhat generic ('when you need automated checks') rather than concrete trigger phrases naming manuscript types or situations.

4 / 5

Trigger Term Quality

Natural keywords users would say are present: 'proofreading', 'spelling', 'grammar', 'Chinese/English manuscripts', 'before submission'. Not a 5 because common synonyms and variations are missing — e.g., 'polish', 'language check', 'bilingual', or file types like '.docx'/'.md' that users would mention.

4 / 5

Distinctiveness Conflict Risk

'Chinese/English manuscripts', 'terminology consistency', and the pre-submission academic context carve out a fairly distinct niche with clear triggers. Minor overlap risk remains with general editing/grammar-check skills, keeping it below a 5; it is well above a 3 since the bilingual academic scope is specific.

4 / 5

Total

16

/

20

Passed

Validation

87%

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

Validation — 14 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

frontmatter_unknown_keys

Unknown frontmatter key(s) found; consider removing or moving to metadata

Warning

referenced_paths_exist

Referenced path issues: 1 missing

Warning

Total

14

/

16

Passed

Repository

aipoch/medical-research-skills

Path

scientific-skills/Other/content-proofreading/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.