oaknational/tsdoc
.agent/skills/tsdoc/SKILL.md
Write and audit canonical TSDoc plus the adjacent README or ADR updates that belong with a code change.
$ install --global
skillsauthnpx skillsauth add oaknational/oak-open-curriculum-ecosystem tsdocInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 15, 2026, 9:51 PM4.9s1 file scanned
SKILL.md
- name:
- tsdoc
- classification:
- passive
- description:
- Write and audit canonical TSDoc plus the adjacent README or ADR updates that belong with a code change.
TSDoc
Use When
Apply this skill when you are:
- adding or changing public TypeScript APIs
- fixing
tsdoc/syntaxwarnings or TypeDoc issues - refactoring code with non-obvious intent, constraints, or trade-offs
- updating a workspace README or ADR alongside code changes
Source of Truth
Read these before making documentation changes:
tsdoc.json.agent/directives/principles.md.agent/directives/testing-strategy.mdwhen documenting test-facing behaviourdocs/engineering/tooling.mdfor the repository's TSDoc enforcement layers
Canonical Constraints
Follow .agent/rules/tsdoc-and-documentation-hygiene.md for the canonical tag, syntax, and comment-style rules.
Documentation Boundary
- TSDoc explains API shape, intent, invariants, examples, and cross-references close to the code.
- Workspace
README.mdfiles explain how to use or operate the workspace. - ADRs capture significant architectural decisions and boundary changes.
- Do not duplicate the same explanation across TSDoc, README, and ADR. Put each concern in its canonical home and link across surfaces where helpful.
Checklist
- Remove non-TSDoc tags such as
@module. - Replace stale names in TSDoc when symbols or concepts are renamed.
- Check whether the code change also requires a README or ADR update.
- For non-trivial public APIs, document
@param,@returns, and an@examplewhere it materially helps usage. - Run the relevant lint and docs gates after editing.
Related Skills
oaknational/worktrees
tools
VerifiedTrustedCommunity
When and how to use git worktrees for isolated work.
3SKILL.mdUpdated Apr 15, 2026
oaknational/tsdoc
documentation
VerifiedTrustedCommunity
TSDoc and documentation workflow for canonical source comments, README updates, and ADR touchpoints.
3SKILL.mdUpdated Apr 15, 2026
oaknational/systematic-debugging
development
VerifiedTrustedCommunity
Structured debugging workflow: reproduce, isolate, hypothesise, verify, fix, regression test.
3SKILL.mdUpdated Apr 15, 2026
oaknational/start-right-thorough
data-ai
VerifiedTrustedCommunity
Load the shared thorough start-right workflow from `.agent/skills/start-right-thorough/shared/start-right-thorough.md`.
3SKILL.mdUpdated Apr 15, 2026