documentation-templates
Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
Install with Tessl CLI
npx tessl i github:lchenrique/politron-ide --skill documentation-templates74
Does it follow best practices?
If you maintain this skill, you can automatically optimize it using the tessl CLI to improve its score:
npx tessl skill review --optimize ./path/to/skillValidation for skill structure
Discovery
32%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 identifies the documentation domain and lists relevant document types, but lacks concrete action verbs describing what the skill does and completely omits trigger guidance for when to use it. The absence of a 'Use when...' clause significantly weakens Claude's ability to select this skill appropriately from a large skill set.
Suggestions
Add a 'Use when...' clause with explicit triggers like 'Use when creating README files, writing API documentation, adding code comments, or preparing documentation for AI consumption.'
Include concrete action verbs describing capabilities, e.g., 'Generates README templates, structures API documentation, formats code comments, and creates AI-friendly documentation.'
Add common keyword variations users might say: 'docs', 'docstrings', 'markdown', '.md files', 'technical writing'.
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | Names the domain (documentation) and lists some document types (README, API docs, code comments, AI-friendly documentation), but doesn't describe concrete actions like 'create', 'generate', or 'format'. | 2 / 3 |
Completeness | Partially answers 'what' (templates and guidelines for documentation types) but completely lacks a 'Use when...' clause or any explicit trigger guidance for when Claude should select this skill. | 1 / 3 |
Trigger Term Quality | Includes relevant keywords like 'README', 'API docs', 'code comments', and 'documentation' that users might say, but missing common variations like 'docstrings', 'markdown', 'docs', or file extensions. | 2 / 3 |
Distinctiveness Conflict Risk | Somewhat specific to documentation but could overlap with general coding skills or markdown formatting skills; 'AI-friendly documentation' adds some distinctiveness but the scope is still broad. | 2 / 3 |
Total | 7 / 12 Passed |
Implementation
92%Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
This is a strong, well-structured skill that provides immediately actionable documentation templates. The content is concise, uses effective formatting (tables, code blocks), and covers a comprehensive range of documentation types. Minor improvement could come from splitting detailed templates into separate reference files for better progressive disclosure.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The content is lean and efficient, using tables and templates without unnecessary explanation. It assumes Claude understands documentation concepts and jumps straight to actionable templates. | 3 / 3 |
Actionability | Provides concrete, copy-paste ready templates for README, API docs, JSDoc, changelog, and ADR formats. Each template is complete and immediately usable. | 3 / 3 |
Workflow Clarity | For a template-focused skill, the workflow is appropriately simple - each section is self-contained with clear structure. The priority order table for README sections provides implicit sequencing where needed. | 3 / 3 |
Progressive Disclosure | Content is well-organized with clear sections, but everything is inline in one file. Some templates (like the full API documentation structure) could benefit from linking to separate detailed reference files. | 2 / 3 |
Total | 11 / 12 Passed |
Validation
90%Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.
Validation — 10 / 11 Passed
Validation for skill structure
| Criteria | Description | Result |
|---|---|---|
allowed_tools_field | 'allowed-tools' contains unusual tool name(s) | Warning |
Total | 10 / 11 Passed | |
- 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.