القائمة
Use when checking if documentation covers all public members of a Scala data type.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Write a how-to guide for practitioners accomplishing a specific task with a ZIO library. Guides are goal-oriented and task-focused, not pedagogical. Use when writing step-by-step practical guides.
Write a tutorial for newcomers learning a topic in a ZIO library. Tutorials teach concepts step-by-step in a linear path for learning-oriented, not task-oriented, purposes. Use when writing comprehensive learning guides.
Reference for mdoc code block modifiers and Docusaurus admonitions used in ZIO documentation. Use when writing or reviewing documentation with Scala code examples.
Write reference documentation for a module containing multiple related data types. Use when documenting a cohesive domain model (e.g. http-model, resource-management) where types work together as a system.
Write reference documentation for a specific ZIO data type. Research the type, write comprehensive documentation with examples, verify mdoc compilation, and integrate into docs.
Integration checklist for new ZIO docs pages. Handles sidebar wiring, index.md linking, and compilation gate (mdoc + Docusaurus build). Cross-referencing is handled separately by the integrate workflow (Phase 2).
| name | docs-report-method-coverage |
| description | Use when checking if documentation covers all public members of a Scala data type. |
Cross-checks the public members of a Scala data type against a reference doc page and reports any members that are not documented.
bash ${CLAUDE_PLUGIN_ROOT}/skills/docs-report-method-coverage/check-method-coverage.sh \
<TypeName> <doc-file.md> [members-file]
Members may be supplied via [members-file] or piped on stdin (typically from /docs-data-type-list-members):
bash ${CLAUDE_PLUGIN_ROOT}/skills/docs-data-type-list-members/extract-members.scala Reader.scala Reader \
| bash ${CLAUDE_PLUGIN_ROOT}/skills/docs-report-method-coverage/check-method-coverage.sh \
Reader docs/reference/reader.md
Run the script with --help for the full usage.
Exit codes:
| Code | Meaning |
|---|---|
0 | Full coverage — every public member is documented. |
1 | One or more members are missing from the documentation. |
2 | Invocation error (missing arguments, file not found, no input). |
For machine-readable output (e.g., CI gates, downstream filtering with jq), pass --json:
bash ${CLAUDE_PLUGIN_ROOT}/skills/docs-report-method-coverage/check-method-coverage.sh \
--json Reader docs/reference/reader.md members.txt | jq '.fullCoverage'
JSON schema:
{
"typeName": "Reader",
"docFile": "docs/reference/reader.md",
"categories": {
"companion": { "total": 5, "documented": 4, "missing": ["foo"] },
"publicApi": { "total": 12, "documented": 12, "missing": [] }
},
"fullCoverage": false
}
Categories with no input members are omitted from the categories object. Exit codes are unchanged in JSON mode.