CtrlK
BlogDocsLog inGet started
Tessl Logo

aps-doc-core

Core documentation generation patterns and framework for Treasure Data pipeline layers. Provides shared templates, quality validation, testing framework, and Confluence integration used by all layer-specific documentation skills.

52

Quality

59%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

High

Do not use without reviewing

Fix and improve this skill with Tessl

tessl review fix ./aps-doc-skills/core/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

63%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 delivers a coherent three-phase workflow with a strong codebase-access gate, concrete tool parameters, and real validation/testing content. Its main weaknesses are verbosity (redundant Summary and When-to-Use sections, and a '60+ checks' claim that lists only 42) and a complete absence of progressive disclosure — the entire framework is packed into one monolithic file. Splitting the template, checklists, and Confluence details into reference files would fix both issues at once.

Suggestions

Split the Standard Documentation Template, the full quality-check catalog, and Confluence tool details into references/ files (e.g. references/template.md, references/quality-checks.md, references/confluence.md) and link them one level deep from SKILL.md.

Delete the 'Summary' restatement section and the 'Benefits' bullets, and reconcile the '60+ Quality Checks' headline with the 42 checks actually listed (or add the missing ones).

Turn the pre-publish validation into an explicit feedback loop: 'validate → if failures, fix and re-validate → only when all checks pass, publish to Confluence'.

DimensionReasoningScore

Conciseness

The body is dense reference material (checklists, SQL, tables) rather than explanation of known concepts, so it avoids the worst failure mode. However, there is noticeable padding: the 'Summary' section restates every prior section with ✅ bullets, 'When to Use This Skill' repeats the frontmatter description, 'Benefits' bullets under Template-Based Documentation add little, and the '60+ Quality Checks' headline understates nothing while the listed checks total 42 (8+7+7+8+6+6). This matches 'mostly efficient but includes some unnecessary explanation or could be tightened'; not a 2 because the bulk is genuinely useful operational content.

3 / 5

Actionability

Most guidance is concrete and executable: the YAML validation command (`python3 -c "import yaml; yaml.safe_load(open('config.yml'))"`), placeholder-detection grep, SQL metadata queries (DESCRIBE, information_schema), Mermaid diagram skeletons, and named MCP tools with parameter lists (`mcp__atlassian__createConfluencePage` with cloudId/spaceId/title/body/parentId). Minor gaps keep it below 5: the Confluence tool calls are shown as YAML parameter descriptions rather than an actual invocation example, and Common Patterns tables use illustrative values (e.g. 'Avg Processing Time | 15 min') without showing how to obtain real values.

4 / 5

Workflow Clarity

The three-phase workflow (Template Analysis → Codebase Exploration → Documentation Generation) is clearly sequenced, with an explicit hard gate up front ('Verify files exist using Glob/Read', 'STOP if cannot read files') and validation before publishing ('Validate quality (60+ checks)', 'Test code examples', plus a six-category testing framework and a Troubleshooting section covering error recovery). Not a 5 because validation is presented as flat checklists without explicit feedback loops (validate → fix → re-validate ordering is implied but never stated as a loop), and the phase-3 steps compress testing and publishing into single bullet lines.

4 / 5

Progressive Disclosure

No bundle files exist (references/, scripts/, assets/ are all absent), so everything — the ~75-line standard template, the 42-item quality checklist, four Mermaid examples, Confluence API details, and six testing categories — is inlined in a ~540-line SKILL.md. Section headers are clear and the Resources section lists external URLs, but content that clearly belongs in separate reference files (the template, the full check catalog) is inlined with no one-level-deep references. This matches 'some structure but could be better organized; content that should be separate is inline'; not a 2 because headers make it navigable.

3 / 5

Total

14

/

20

Passed

Description

55%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.

The description communicates a clear, domain-specific 'what' with several concrete components, but entirely lacks 'when to use' trigger guidance, which caps both completeness and trigger-term quality. It also risks colliding with the layer-specific sibling skills it references. Adding an explicit 'Use when...' clause with natural trigger phrases would resolve the biggest weaknesses.

Suggestions

Add an explicit trigger clause, e.g. 'Use when creating or extending Treasure Data pipeline documentation, publishing layer docs to Confluence, or building custom documentation workflows'.

Include the natural terms users would actually say — 'generate docs', 'document a pipeline', 'Confluence page', '.dig/.sql workflow files' — to improve trigger-term coverage.

Sharpen the boundary with sibling skills (e.g. 'For standard ingestion/staging/golden layer docs, use the layer-specific skills instead') to reduce conflict risk.

DimensionReasoningScore

Specificity

The description names the domain ('Core documentation generation patterns and framework for Treasure Data pipeline layers') and lists several concrete deliverables: 'shared templates, quality validation, testing framework, and Confluence integration'. It falls between the 3 anchor (1-2 concrete actions) and the 5 anchor (comprehensive coverage of actions), because 'patterns and framework' is somewhat abstract and the actual generation actions (analyze template, extract schema, publish) are not spelled out — closer to 'lists several specific actions; minor gaps'.

4 / 5

Completeness

The 'what' is clearly stated (shared templates, quality validation, testing framework, Confluence integration), but there is no 'when' — no 'Use when...' clause or equivalent trigger guidance anywhere in the description, which per the judging guidelines caps completeness at 3. Not a 2 because the 'what' is concrete rather than vague.

3 / 5

Trigger Term Quality

'Documentation', 'Treasure Data', 'pipeline layers', and 'Confluence' are relevant keywords, but the natural phrases a user would say ('generate docs', 'document a pipeline', 'write Confluence documentation', file extensions like .dig) are missing. This matches 'some relevant keywords but missing common variations or synonyms'; not a 4 because there is no 'Use when' phrasing and no synonyms for 'documentation'.

3 / 5

Distinctiveness Conflict Risk

The Treasure Data pipeline documentation niche is fairly specific, but the closing phrase 'used by all layer-specific documentation skills' creates real overlap risk: a user asking to 'document my ingestion layer' or 'publish pipeline docs to Confluence' would plausibly trigger this core skill instead of the layer-specific sibling skills. This matches 'somewhat specific but could still overlap with similar skills'; not a 4 because the conflict with its own sibling skills is more than minor.

3 / 5

Total

13

/

20

Passed

Validation

93%

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

Validation — 15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

skill_md_line_count

SKILL.md is long (567 lines); consider splitting into references/ and linking

Warning

Total

15

/

16

Passed

Repository
treasure-data/td-skills
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.