メニュー
Code docs: TSDoc, JSDoc, pydoc, rustdoc, TypeDoc, MkDocs, Sphinx. Use when setting up docstrings, configuring a docs generator, or enforcing doc coverage in CI.
デフォルトでは、最初にソースを確認する Prompt が選択されています。直接コマンドに切り替えるか、ローカルコピーをダウンロードすることもできます。
インストールを決める前に、SKILL.md と SkillsMP に表示されている付属ファイルをお読みください。
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
直接コマンドでは確認用 Prompt が省略されます。実行前にソースを確認してください。
npx skills add https://github.com/laurigates/claude-plugins --skill configure-docsコマンドは1行のまま表示されます。コピー前に横へスクロールして全体を確認してください。
ローカルで確認しますか？SkillsMP が現在取得できるファイルをダウンロードできます。
SKILL.md を表示中
SOC 職業分類に基づく
| created | "2025-12-16T00:00:00.000Z" |
| modified | "2026-04-19T00:00:00.000Z" |
| reviewed | "2025-12-16T00:00:00.000Z" |
| description | Code docs: TSDoc, JSDoc, pydoc, rustdoc, TypeDoc, MkDocs, Sphinx. Use when setting up docstrings, configuring a docs generator, or enforcing doc coverage in CI. |
| allowed-tools | Glob, Grep, Read, Write, Edit, Bash, AskUserQuestion, TodoWrite |
| args | [--check-only] [--fix] [--level <minimal|standard|strict>] [--type <typescript|javascript|python|rust>] [--generator <typedoc|sphinx|mkdocs|rustdoc>] |
| argument-hint | [--check-only] [--fix] [--level <minimal|standard|strict>] [--type <typescript|javascript|python|rust>] [--generator <typedoc|sphinx|mkdocs|rustdoc>] |
| name |
| configure-docs |
Check and configure code documentation standards and generators.
| Use this skill when... | Use another approach when... |
|---|---|
| Setting up TSDoc, JSDoc, pydoc, or rustdoc standards for a project | Writing actual documentation content for functions or modules |
| Configuring a documentation generator (TypeDoc, MkDocs, Sphinx, rustdoc) | Deploying documentation to GitHub Pages (/configure:github-pages instead) |
| Auditing documentation coverage and lint compliance | Reviewing generated documentation for accuracy |
| Adding documentation enforcement rules to CI/CD | Editing ruff or biome configuration for non-doc rules (/configure:linting) |
| Migrating between documentation conventions (e.g., numpy to google style) | Setting up pre-commit hooks only (/configure:pre-commit instead) |
pwdfind . -maxdepth 1 \( -name 'package.json' -o -name 'pyproject.toml' -o -name 'Cargo.toml' \)find . -maxdepth 1 -name 'biome.json'find . -maxdepth 1 \( -name 'tsdoc.json' -o -name 'typedoc.json' \)find . -maxdepth 1 \( -name 'pyproject.toml' -o -name 'ruff.toml' -o -name '.ruff.toml' \)find . -maxdepth 1 \( -name 'Cargo.toml' -o -name 'clippy.toml' \)find . -maxdepth 1 -name '.pre-commit-config.yaml'find . -maxdepth 1 \( -name 'mkdocs.yml' -o -name 'docusaurus.config.*' \)find . -maxdepth 1 -type d -name 'docs'Parse from command arguments:
--check-only: Report compliance status without modifications (CI/CD mode)--fix: Apply fixes automatically without prompting--level <minimal|standard|strict>: Documentation enforcement level (default: standard)--type <typescript|javascript|python|rust>: Override language detection--generator <typedoc|sphinx|mkdocs|rustdoc>: Override documentation generator detectionEnforcement Levels:
minimal: Syntax validation only (valid doc comments)standard: Public API documentation required (recommended)strict: All items documented, including privateGenerator Auto-Detection:
| Project Type | Default Generator |
|---|---|
| TypeScript/JavaScript | TypeDoc |
| Python | MkDocs (simpler) or Sphinx |
| Rust | rustdoc |
| Multi-language/Other | MkDocs |
Execute this documentation standards configuration check:
Identify language(s) from file structure:
| Indicator | Language |
|---|---|
package.json + tsconfig.json | TypeScript |
package.json (no tsconfig) | JavaScript |
pyproject.toml or *.py files | Python |
Cargo.toml | Rust |
For multi-language projects, configure each detected language. Allow --type override to focus on one.
For each detected language, check existing configuration:
TypeScript/JavaScript:
tsdoc.json exists (TypeScript)Python:
pyproject.toml has [tool.ruff.lint.pydocstyle] sectionRust:
Cargo.toml has [lints.rust] sectionmissing_docs lint configured[lints.rustdoc] section for rustdoc-specific lintsPrint a formatted compliance report:
Documentation Standards Compliance Report
=========================================
Project: [name]
Languages: [detected languages]
Enforcement Level: [minimal|standard|strict]
Linting Standards:
TypeScript/JavaScript:
tsdoc.json [PASS | MISSING | N/A]
TypeDoc configured [PASS | MISSING | OUTDATED]
API docs generated [PASS | DISABLED]
Python:
ruff pydocstyle [PASS | MISSING]
convention [google | not set]
D rules enabled [PASS | DISABLED]
Rust:
missing_docs lint [PASS | DISABLED]
rustdoc lints [PASS | PARTIAL]
Documentation Generator:
Generator type [typedoc|mkdocs|sphinx|rustdoc] [DETECTED | SUGGESTED]
Config file [config path] [EXISTS | MISSING]
Build script [command] [EXISTS | MISSING]
Output directory [docs/|site/|target/doc/] [EXISTS | NOT BUILT]
Overall: [X issues found]
Next Steps:
- Run `[build command]` to generate documentation locally
- Run `/configure:github-pages` to set up deployment
If --check-only, stop here.
Apply configuration based on detected language. Use templates from REFERENCE.md:
tsdoc.json with schema referencenpm install --save-dev typedoctypedoc.json with entry points and output directorypyproject.toml with [tool.ruff.lint.pydocstyle] sectiongoogle (or numpy for scientific projects)Cargo.toml with [lints.rust] sectionmissing_docs = "warn" (standard) or "deny" (strict)[lints.rustdoc] section for broken link detectionCreate tests to validate documentation compliance:
docs:check script running typedoc --emit noneruff check --select D on sourcecargo doc --no-deps and cargo clippy -- -W missing_docs to CIUse test templates from REFERENCE.md.
Auto-detect or configure the documentation site generator:
--generator provided, use specified generatorUse generator templates from REFERENCE.md.
If .pre-commit-config.yaml exists, add documentation hooks for the detected language. Use hook templates from REFERENCE.md.
Update .project-standards.yaml:
standards_version: "2025.1"
project_type: "[detected]"
last_configured: "[timestamp]"
components:
docs: "2025.1"
docs_level: "[minimal|standard|strict]"
docs_languages: ["typescript", "python", "rust"]
For detailed configuration templates, see REFERENCE.md.
Provide:
| Context | Command |
|---|---|
| Quick compliance check | /configure:docs --check-only |
| Auto-fix all issues | /configure:docs --fix |
| Check TSDoc validity | `typedoc --emit none 2>&1 |
| Check Python docstrings | ruff check --select D --output-format=github |
| Check Rust doc lints | `cargo doc --no-deps 2>&1 |
| Build docs (MkDocs) | `mkdocs build --strict 2>&1 |
/configure:github-pages - Set up GitHub Pages deployment/configure:all - Run all compliance checks/configure:status - Quick compliance overview/configure:pre-commit - Pre-commit hook configurationInstall, configure and troubleshoot MCP servers. Use when adding/enabling servers, editing .mcp.json, fixing OAuth, or when a server runs stale code after an upstream fix.
FinOps snapshot — org billing, workflow stats, cache usage. Use when you want a high-level view of CI spending or workflow health before diving deeper.
GitHub Actions billing, workflow efficiency, and waste analysis at org or repo level. Use when investigating CI/CD costs, wasted runs, or optimizing triggers.