fsharp-doc-comments
Defines rules for clean doc comments (///) that describe code contracts without referencing downstream dependencies.
Install
mkdir -p .claude/skills/fsharp-doc-comments && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/15950" && unzip -o skill.zip -d .claude/skills/fsharp-doc-comments && rm skill.zipInstalls to .claude/skills/fsharp-doc-comments
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
How to write `///` doc comments on F# types and functions (and JSDoc on TS exports) in Wilnaatahl. Use before adding or editing any doc comment. These are the rules past sessions most often slipped on — read before touching F#.Key capabilities
- →Describe the contract of a value or function in isolation
- →Capture invariants, error shapes, and semantic nuances in doc comments
- →Preserve existing comments during refactoring
- →Update comments when behavior changes
- →Verify asserted properties of code before committing
- →Avoid referencing downstream callers in doc comments
How it works
This skill guides the creation of doc comments by focusing on describing the value in isolation and avoiding references to external dependencies or test knowledge.
Inputs & outputs
When to use fsharp-doc-comments
- →Writing doc comments
- →Refactoring existing documentation
- →Setting documentation standards
About fsharp-doc-comments
Provides standards for writing documentation that remains accurate regardless of how the code is consumed.
>-
When not to use it
- →When referencing downstream callers, consumers, or illustrative examples
- →When encoding test knowledge in non-test comments
- →When justifying field absences by pointing at a consumer
Limitations
- →Doc comments must not contain version numbers
- →Doc comments must not restate the F# type signature
- →Comments in a dependency module must not reference the consumer
How it compares
This skill enforces a strict decoupling principle for doc comments, ensuring they remain accurate and independent of external code changes, unlike comments that might create hidden dependencies.
Compared to similar skills
fsharp-doc-comments side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| fsharp-doc-comments (this skill) | 0 | 3mo | No flags | Intermediate |
| deepwiki-rs | 25 | 11mo | Review | Intermediate |
| codex-cli-bridge | 9 | 11mo | Review | Intermediate |
| skill-development | 17 | 10mo | Review | Intermediate |
Try saying
Example prompts that trigger this skill in your AI assistant.
You might also like
deepwiki-rs
sopaco
AI-powered Rust documentation generation engine for comprehensive codebase analysis, C4 architecture diagrams, and automated technical documentation. Use when Claude needs to analyze source code, understand software architecture, generate technical specs, or create professional documentation from any programming language.
codex-cli-bridge
alirezarezvani
Bridge between Claude Code and OpenAI Codex CLI - generates AGENTS.md from CLAUDE.md, provides Codex CLI execution helpers, and enables seamless interoperability between both tools
skill-development
anthropics
This skill should be used when the user wants to "create a skill", "add a skill to plugin", "write a new skill", "improve skill description", "organize skill content", or needs guidance on skill structure, progressive disclosure, or skill development best practices for Claude Code plugins.
skill-writer
pytorch
Guide users through creating Agent Skills for Claude Code. Use when the user wants to create, write, author, or design a new Skill, or needs help with SKILL.md files, frontmatter, or skill structure.
openapi-spec-generation
wshobson
Generate and maintain OpenAPI 3.1 specifications from code, design-first specs, and validation patterns. Use when creating API documentation, generating SDKs, or ensuring API contract compliance.
korean-skill-creator
clwmfksek
한글 기반 클로드 스킬 자동 생성 도구. 사용자가 "클로드 스킬을 만들어줘" 또는 "[요구사항] 스킬 만들어줘"라고 요청할 때 사용. Progressive disclosure 원칙을 따르는 한글 문서 구조(SKILL.md + references/)를 자동으로 생성하고, 실전 예시를 포함한 일관성 있는 스킬 템플릿을 제공.