How do I install the 4d Doc Coverage skill?

Run npx skillmds@latest add e-marchand/4d-doc-coverage in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is 4d Doc Coverage safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with 4d Doc Coverage?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is 4d Doc Coverage free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published 4d Doc Coverage?

e-marchand (@e-marchand) published this skill. Their other Agent Skills are listed on their SkillMD profile.

4d Doc Coverage by e-marchand — Agent Skill

Name: 4d Doc Coverage
Author: e-marchand

4d Doc Coverage

Check that public 4D class methods/functions are documented and report documentation gaps. Use when the user asks whether public API is documented, to find undocumented methods/functions/properties, audit doc coverage before a release/PR, or verify a new public member was added to Documentation/Classes. Runs a Python script that compares Project/Sources/Classes against Documentation/Classes.

e-marchand a356fa2 2 files · 9.9 KB Updated Sep 17, 2026

File contents

4D Documentation Coverage

When to Use

The user asks "is this public method/function documented?" or "did we forget to document X?".
Auditing documentation gaps before a release or in a PR review.
After adding or renaming a public class member, to confirm the Markdown docs were updated.
Wiring a CI check that fails when a public member is undocumented.

What It Checks

The repo convention this skill relies on:

Concept	Rule
Public class	`.4dm` file in `Project/Sources/Classes/` not starting with `_`.
Public member	`Function <name>` (or `Function get/set <name>` property) not starting with `_`. `Class constructor` is ignored.
Documentation	`Documentation/Classes/<ClassName>.md`. A member counts as documented when its name appears as a `### name` heading, a `name` bold signature, or a `name` inline-code cell in a property table.

A "gap" is a public member with no matching entry in its class doc, or a public class with no doc file at all.

Procedure

Run the checker from the repository root:
```
python3 $SKILL_DIR/scripts/check_doc_coverage.py
```
Add --json for machine-readable output, or --root <path> to point at a different checkout. The script exits 1 when any gap is found (CI-friendly), 0 when everything is documented.
Read the report. Each class is either ✓ (fully documented) or ✗ with the undocumented members listed as name (kind, line N).
For each reported gap, decide with the user:
- Real gap → open Documentation/Classes/<ClassName>.md and add a section for the member, following the existing style in that file (method → ### name() + **name**(...) signature + tables; property → a row in the Properties/Computed properties table). Match the closest existing entry.
- Intentional → if the member is public only for technical reasons and should not be documented, leave it; note the decision so it is not re-flagged repeatedly.
Re-run the script to confirm the gap is closed (exit 0, class shows ✓).

Notes & Limitations

Detection is heuristic (name presence, not signature accuracy). It confirms a member is mentioned, not that the signature or parameters are correct — a human should sanity-check the actual content.
A member documented only in unrelated prose that happens to contain its name may be counted as documented; prefer real headings/tables when writing docs.
The private convention is the leading underscore _; adjust the script arguments if a project uses a different convention.

See the implementation in check_doc_coverage.py.

---name: 4d-doc-coveragedescription: Check that public 4D class methods/functions are documented and report documentation gaps. Use when the user asks whether public API is documented, to find undocumented methods/functions/properties, audit doc coverage before a release/PR, or verify a new public member was added to Documentation/Classes. Runs a Python script that compares Project/Sources/Classes against Documentation/Classes.---# 4D Documentation Coverage## When to Use- The user asks "is this public method/function documented?" or "did we forget to document X?".- Auditing documentation gaps before a release or in a PR review.- After adding or renaming a public class member, to confirm the Markdown docs were updated.- Wiring a CI check that fails when a public member is undocumented.## What It ChecksThe repo convention this skill relies on:| Concept | Rule ||---------|------|| Public class | `.4dm` file in `Project/Sources/Classes/` **not** starting with `_`. || Public member | `Function <name>` (or `Function get/set <name>` property) **not** starting with `_`. `Class constructor` is ignored. || Documentation | `Documentation/Classes/<ClassName>.md`. A member counts as documented when its name appears as a `### name` heading, a `**name**` bold signature, or a `` `name` `` inline-code cell in a property table. |A "gap" is a public member with no matching entry in its class doc, or a public class with no doc file at all.## Procedure1. Run the checker from the repository root: ```bash python3 $SKILL_DIR/scripts/check_doc_coverage.py ``` Add `--json` for machine-readable output, or `--root <path>` to point at a different checkout. The script exits `1` when any gap is found (CI-friendly), `0` when everything is documented.2. Read the report. Each class is either `✓` (fully documented) or `✗` with the undocumented members listed as `name (kind, line N)`.3. For each reported gap, decide with the user: - **Real gap** → open `Documentation/Classes/<ClassName>.md` and add a section for the member, following the existing style in that file (method → `### name()` + `**name**(...)` signature + tables; property → a row in the Properties/Computed properties table). Match the closest existing entry. - **Intentional** → if the member is public only for technical reasons and should not be documented, leave it; note the decision so it is not re-flagged repeatedly.4. Re-run the script to confirm the gap is closed (exit `0`, class shows `✓`).## Notes & Limitations- Detection is heuristic (name presence, not signature accuracy). It confirms a member is *mentioned*, not that the signature or parameters are correct — a human should sanity-check the actual content.- A member documented only in unrelated prose that happens to contain its name may be counted as documented; prefer real headings/tables when writing docs.- The private convention is the leading underscore `_`; adjust the script arguments if a project uses a different convention.See the implementation in [check_doc_coverage.py](./scripts/check_doc_coverage.py).

Frequently asked questions