ladder-logic-docstrings
Installation
SKILL.md
Ladder Logic Docstrings
Use this skill to add or normalize rung, routine, and tag comments in Ladder Logic code so external tools can discover API intent without reverse-engineering the implementation.
Intent Router
| Need | Load |
|---|---|
| preferred syntax, extraction path, and caveats | references/docstrings.md |
Quick Start
- Inspect the repository for an existing documentation convention.
- Preserve an established machine-readable style when it already works with external tooling.
- Otherwise standardize on rung, routine, and tag comments for the requested Ladder Logic surface.
- Document public and externally consumed symbols before private helpers.
- Keep names, parameters, return semantics, and examples aligned with the real code.