shdoc-shell-docs
CommunityClarify shell scripts with clean shdoc docs
Authorshunk031
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Writing clear, consistent shdoc annotations for shell scripts can be tedious and error-prone; this skill automates the process and enforces standards.
Core Features & Use Cases
- Auto-add and review file-level and function-level shdoc tags (e.g., @file, @brief, @description, @arg, @option, @example).
- Validate documentation against the repository's style guide in references/shdoc-rules.md to ensure consistency across projects.
- Improve maintainability by keeping shell script docs synchronized with code, enabling generated references and better onboarding.
Quick Start
Use shdoc-shell-docs to annotate and review a target script like scripts/build.sh to ensure proper documentation.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: shdoc-shell-docs Download link: https://github.com/shunk031/dotfiles/archive/main.zip#shdoc-shell-docs Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 510,000+ vetted skills library on demand.