Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing tutorials and user guides. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, getting started guides.
The author's original description, preserved in English. It describes intent, not verified performance.
Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing tutorials and user guides. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, getting started guides.
Adds and validates technical documentation such as docstrings, JSDoc, OpenAPI specs and guides, asking for format preferences first and testing examples before reporting.
Review scope
Deterministic static analysis of collected SKILL.md and supporting text/code. Machine-assisted candidates and findings await human editorial review; no dynamic behavior or effect is assessed.
Observable capabilities
Asks for format preference and exclusions, then detects language and framework.
Finds undocumented code and applies a consistent documentation style.
Validates examples with doctest, tsc --noEmit or Redocly lint, and fixes failures before reporting.
Generates a documentation coverage summary.
Limitations & scope
Validation tools such as pytest, tsc and Redocly must be installed and relevant to the project.
Passing doctest or compile checks does not prove the prose is accurate.
Doc site and tutorial guidance is in separate references and not detailed in the main file.
Relevant for
Developers documenting public APIs
Teams producing OpenAPI or JSDoc coverage
Maintainers writing getting-started guides
02 / STRUCTURE
What ships with the skill
The file inventory comes from the collected source at the recorded commit. Paths and sizes are structural observations, not a measure of quality.
{
"name": "code-documenter",
"description": "Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing tutorials and user guides. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, getting started guides.",
"license": "MIT",
"metadata": {
"author": "https://github.com/Jeffallan",
"company": "https://synergetic.solutions",
"version": "1.1.0",
"domain": "quality",
"triggers": "documentation, docstrings, OpenAPI, Swagger, JSDoc, comments, API docs, tutorials, user guides, doc site",
"role": "specialist",
"scope": "implementation",
"output-format": "code",
"related-skills": "spec-miner, fullstack-guardian, code-reviewer"
}
}
03 / WORKFLOW
A reading of the operating sequence
This workflow reconstructs the apparent sequence from source material. Unless controlled evaluation is explicitly recorded, it is provisional—not an observed trace.
01
Input
Ask for preferences
Ask for the format preference and exclusions before starting.
Static findings identify points to inspect before installation. They do not establish that a skill is safe, malicious, or effective.
Attention recommended
93 deterministic lexical finding(s) require review across the collected text. Findings can occur in documentation and do not prove execution or exploitability; binary-only files were not scanned.
Network accessObserved
File writesObserved
Credential useObserved
Note
File modification is described or implemented
59 occurrences
This line contains a possible file-write or redirection operation. Check destination paths and overwrite behavior; the static review did not write any file. This rule matched 59 location(s) in the collected text; 3 representative location(s) are cited. Matching text may be documentation, and the analyzer did not execute it.
A URL or network client appears in this source line. Review destinations, data sent, and trust boundaries; static text cannot establish actual network activity. This rule matched 22 location(s) in the collected text; 3 representative location(s) are cited. Matching text may be documentation, and the analyzer did not execute it.
This line resembles a credential literal or reads a sensitive environment value. Do not expose its contents; verify whether it is a placeholder, required secret, or accidentally committed material. This rule matched 12 location(s) in the collected text; 3 representative location(s) are cited. Matching text may be documentation, and the analyzer did not execute it.
Check that documentation examples and generated specs do not leak real keys, internal URLs or private endpoint details.
05 / CONTEXT
Where context can be spent
Discovery, activation, and resource layers have different meanings. Exact values appear only when the official token-counting method was run with a named model.
Exact token counts unavailable
All token values, including per-file inventory, are null until the pipeline performs an official exact count with an explicit model.
No token measurement was recorded with the required official method. This dossier does not substitute character counts, file sizes, or estimates.
06 / EVALUATION
Controlled evaluation
No controlled evaluation
This skill has only the evidence identified above. No task success, token efficiency, latency, or quality advantage is claimed.
Not tested
07 / USAGE
Use with the source in view
Install command
git clone https://github.com/Jeffallan/claude-skills.git
cd claude-skills
# Copy this skill directory into one of:
# ~/.claude/skills/code-documenter
# .claude/skills/code-documenter
Open the pinned source at https://github.com/Jeffallan/claude-skills/blob/67c1961b180dc92cf08983344627109e983e8f51/skills/code-documenter/SKILL.md.
Review the license, prerequisites and all bundled reference files.
Install the skill into a personal or project-level Claude Code skills directory.
Restart or refresh Claude Code so the skill can be discovered.
Verify installation
Confirm code-documenter/SKILL.md exists at the destination, then ask Claude Code to use the code-documenter skill on a small test task.
Prerequisites
Validation tools such as pytest, tsc and Redocly must be installed and relevant to the project.
Passing doctest or compile checks does not prove the prose is accurate.
Doc site and tutorial guidance is in separate references and not detailed in the main file.
Example prompts
Representative task
Use the code-documenter skill to add Google-style docstrings to the public functions in src/users.py, ask me about format first, and validate the examples with doctest.
Inspect before use
Read the code-documenter skill at https://github.com/Jeffallan/claude-skills/blob/67c1961b180dc92cf08983344627109e983e8f51/skills/code-documenter/SKILL.md and its referenced files. Explain its workflow, required tools, permissions and the main risks before I decide whether to install it.
08 / VERDICT
A decision, with its limits attached
Strengths
Requires asking for docstring format instead of assuming one.
Ties documentation to executable validation of examples.
Considerations
Documenting all public functions can create large diffs.
Coverage reports measure presence of documentation, not its quality.
Research conclusion
A dependable documentation workflow that is strongest where examples can be compiled or linted.
09 / PROVENANCE
Traceable by construction
The dossier is a time-bound reading of a public artifact, not an endorsement. Use the source link to inspect the exact upstream material.
Deterministic lexical parsing, YAML frontmatter validation, file inventory, source-described workflow extraction, and heuristic provisional classification of the supplied files only. Generated by machine; no LLM, execution, dynamic testing, or human editorial approval.