CtrlK
BlogDocsLog inGet started
Tessl Logo

mcollina/documentation

Creates, structures, and reviews technical documentation following the Diátaxis framework (tutorials, how-to guides, reference, and explanation pages). Use when a user needs to write or reorganize docs, structure a tutorial vs. a how-to guide, build reference docs or API documentation, create explanation pages, choose between Diátaxis documentation types, or improve existing documentation structure. Trigger terms include: documentation structure, Diátaxis, tutorials vs how-to guides, organize docs, user guide, reference docs, technical writing.

91

1.11x
Quality

87%

Does it follow best practices?

Impact

96%

1.11x

Average score across 5 eval scenarios

SecuritybySnyk

Passed

No known issues

Overview
Quality
Evals
Security
Files

criteria.jsonevals/scenario-5/

{
  "context": "Tests whether the agent correctly separates mixed documentation into distinct Diátaxis types, adds cross-links between related pages, and applies consistent headings and terminology across all output documents.",
  "type": "weighted_checklist",
  "checklist": [
    {
      "name": "Tutorial separated",
      "description": "The tutorial content (install + first sync walkthrough) is extracted into its own dedicated file and not combined with reference or explanation content",
      "max_score": 8
    },
    {
      "name": "How-to separated",
      "description": "The how-to guide content (scheduling with cron) is extracted into its own dedicated file",
      "max_score": 8
    },
    {
      "name": "Reference separated",
      "description": "The CLI flags reference content is in its own dedicated file and does not include the conceptual paragraph about when/why to use --dry-run",
      "max_score": 8
    },
    {
      "name": "Explanation separated",
      "description": "The conflict resolution explanation is in its own dedicated file and does not include step-by-step instructions",
      "max_score": 8
    },
    {
      "name": "Each file is a single type",
      "description": "No output file mixes content from two or more Diátaxis types — e.g., the tutorial file does not include a reference table of .syncflow.toml options, and the reference file does not include tutorial steps",
      "max_score": 12
    },
    {
      "name": "Cross-links present",
      "description": "At least two output files include Markdown links to other output files in the set (e.g., the tutorial links to the reference page, or the how-to links to the explanation)",
      "max_score": 10
    },
    {
      "name": "Consistent 'workspace' terminology",
      "description": "All output files use 'workspace' consistently and do NOT use 'directory', 'folder', or 'project' as synonyms for it",
      "max_score": 8
    },
    {
      "name": "Consistent 'sync job' terminology",
      "description": "All output files use 'sync job' consistently and do NOT alternate between 'job', 'task', and 'sync' to refer to the same concept",
      "max_score": 8
    },
    {
      "name": "Tutorial heading pattern",
      "description": "The tutorial file's title starts with a verb (e.g., 'Run', 'Create', 'Set up', 'Build') rather than a noun or 'How to'",
      "max_score": 8
    },
    {
      "name": "How-to heading pattern",
      "description": "The how-to guide file's title starts with 'How to' rather than a bare verb or noun phrase",
      "max_score": 8
    },
    {
      "name": "Reference heading pattern",
      "description": "The reference file's title names the subject directly (e.g., 'CLI Flags', 'syncflow CLI Reference') without framing it as a task or concept",
      "max_score": 8
    },
    {
      "name": "Index file produced",
      "description": "An index.md file is produced listing all pages with each page's documentation type identified",
      "max_score": 6
    }
  ]
}

evals

SKILL.md

tile.json