bee:api-field-descriptions
CommunityWrite clear, consistent API field descriptions.
Software Engineering#technical writing#developer experience#api documentation#field descriptions#schema documentation
Authorluanrodrigues
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill helps developers write clear, consistent, and comprehensive descriptions for API fields, ensuring that documentation is easily understood and useful for consumers.
Core Features & Use Cases
- Standardized Structure: Provides a template for describing fields, including type, requirements, constraints, and examples.
- Type-Specific Patterns: Offers guidance on how to describe fields based on their data type (UUID, string, enum, etc.).
- Use Case: When documenting a new API endpoint, use this Skill to ensure that every field in the request and response payloads is clearly explained, including its purpose, format, and any limitations.
Quick Start
Use the bee:api-field-descriptions skill to document the 'user_id' field as a required UUID.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 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: bee:api-field-descriptions Download link: https://github.com/luanrodrigues/ia-frmwrk/archive/main.zip#bee-api-field-descriptions 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 223,000+ vetted skills library on demand.