dengineproblem/agents-monorepo68 installs
feature-documentation
Эксперт feature documentation. Используй для документации функций, release notes, user guides и product documentation.
How do I install this agent skill?
npx skills add https://github.com/dengineproblem/agents-monorepo --skill feature-documentationIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill is a purely instructional guide for generating feature documentation. It contains no executable code, network requests, or data access commands.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
- Runlayerwarn
1/1 file flagged
What does this agent skill do?
Feature Documentation Expert
Expert in creating comprehensive, user-focused feature documentation.
Core Documentation Principles
Structure and Hierarchy
- Purpose-First Organization: Start with what the feature does and why it matters
- Progressive Disclosure: Layer information from overview to implementation details
- Multiple Entry Points: Support different user types (end-users, developers, stakeholders)
- Cross-Reference Integration: Link related features, dependencies, and prerequisites
Content Framework
# Feature Name
## Overview
- **Purpose**: What problem does this solve?
- **Target Users**: Who benefits from this feature?
- **Key Benefits**: Primary value propositions
## How It Works
- **Core Functionality**: Technical behavior description
- **User Flow**: Step-by-step interaction patterns
- **System Integration**: How it connects with existing features
## Implementation
- **Technical Requirements**: Dependencies, versions, constraints
- **Configuration**: Setup and customization options
- **Code Examples**: Practical usage demonstrations
## Reference
- **Parameters**: Complete specification details
- **Error Handling**: Common issues and solutions
- **Performance**: Limitations, optimization tips
User-Centric Documentation Patterns
Scenario-Based Examples
## Use Cases
### Scenario 1: E-commerce Product Search
**Context**: Customer searching for specific product attributes
**Steps**:
1. User enters search query
2. Feature parses attributes
3. Returns filtered results with relevance scoring
**Expected Outcome**: Highly relevant products displayed
Task-Oriented Structure
- Quick Start: Get users to first success in under 5 minutes
- Common Tasks: Address 80% of typical use cases
- Advanced Usage: Power user scenarios and customization
- Troubleshooting: Anticipated problems with specific solutions
Technical Implementation Documentation
API Documentation Standards
paths:
/api/v1/search:
post:
summary: Advanced product search with filtering
description: |
Performs intelligent search across product catalog
**Rate Limits**: 100 requests/minute per API key
**Response Time**: Typically < 200ms
Cross-Functional Communication
Stakeholder Summary Template
## Executive Summary: Feature Name
**Business Impact**: Key metrics improvements
**Development Effort**: Timeline estimate
**Dependencies**: Required resources
**Success Metrics**: How we measure success
**Risks & Mitigations**: Potential issues and solutions
Release Notes Format
## New Feature: Feature Name v2.1
**What's New**: List of new capabilities
**For Developers**: Code examples
**Breaking Changes**: Migration requirements
Quality Assurance Practices
Documentation Review Checklist
- All code examples tested and functional
- Covers happy path, edge cases, and error scenarios
- Technical and non-technical users can understand
- Version-specific information clearly marked
- Proper heading structure, alt text for images
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/dengineproblem/agents-monorepo/feature-documentation">View feature-documentation on skillZs</a>