Agent skill
documentation-writer
Activates when creating or improving technical documentation, READMEs, and API docs
Install this agent skill to your Project
npx add-skill https://github.com/fusionet24/AISkills/tree/main/skills/documentation-writer
SKILL.md
Documentation Writer
Overview
This skill specializes in creating clear, comprehensive, and well-structured technical documentation. It helps with READMEs, API documentation, user guides, and inline code comments.
Instructions
When creating or improving documentation:
- Identify Audience: Determine who will read this documentation (developers, end-users, etc.)
- Structure Content: Organize information logically with clear sections
- Be Clear and Concise: Use simple language and avoid jargon when possible
- Provide Examples: Include code examples and use cases
- Keep Updated: Ensure documentation matches current implementation
Documentation Elements
README Structure
- Project title and description
- Installation instructions
- Quick start guide
- Usage examples
- API reference (if applicable)
- Contributing guidelines
- License information
API Documentation
- Endpoint/function purpose
- Parameters with types and descriptions
- Return values
- Error handling
- Example requests and responses
Examples
Example 1: Function Documentation
Input:
def process_data(data, filter=None):
# Process the data
result = []
for item in data:
if filter and not filter(item):
continue
result.append(transform(item))
return result
Output:
def process_data(data, filter=None):
"""
Process and transform a collection of data items with optional filtering.
Args:
data (list): A list of items to process
filter (callable, optional): A function that returns True for items
to include. If None, all items are processed.
Returns:
list: A list of transformed items that passed the filter
Example:
>>> data = [1, 2, 3, 4, 5]
>>> process_data(data, filter=lambda x: x > 2)
[3, 4, 5]
"""
result = []
for item in data:
if filter and not filter(item):
continue
result.append(transform(item))
return result
Example 2: README Section
Input: Project is a web scraper
Output:
# Web Scraper Tool
A lightweight, efficient web scraping library for extracting structured data from websites.
## Features
- 🚀 Fast and asynchronous scraping
- 🛡️ Built-in rate limiting and error handling
- 📊 Export data to JSON, CSV, or databases
- 🔍 CSS and XPath selector support
## Installation
```bash
pip install web-scraper-tool
Quick Start
from scraper import WebScraper
# Initialize scraper
scraper = WebScraper()
# Scrape a website
data = scraper.scrape('https://example.com', {
'title': 'h1.title',
'price': '.price'
})
print(data)
Documentation
For detailed documentation, visit docs.example.com
## Notes
- Keep documentation up-to-date with code changes
- Use consistent formatting and style
- Include visual aids when helpful (diagrams, screenshots)
- Test all code examples to ensure they work
- Consider internationalization for broader audiences
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
skill-name
A clear description of when this skill should activate and what it does
pyspark-test-generator
Generate comprehensive PySpark-based data quality validation tests for Databricks tables. Use when creating automated tests for data completeness, accuracy, consistency, and conformity, or when user mentions test generation, data validation, quality monitoring, or PySpark test frameworks.
data-profiler
Profile datasets to understand schema, quality, and characteristics. Use when analyzing data files (CSV, JSON, Parquet), discovering dataset properties, assessing data quality, or when user mentions data profiling, schema detection, data analysis, or quality metrics. Provides basic and intermediate profiling including distributions, uniqueness, and pattern detection.
test-generator
Activates when generating unit tests, integration tests, or test cases for code
unity-catalog-tagger
Manage Unity Catalog metadata tags for data governance and classification. Use when applying tags to tables and columns, classifying data sensitivity (PII, PHI), marking data quality attributes, or when user mentions Unity Catalog tagging, metadata management, data governance, or compliance workflows.
databricks-query
Execute SQL queries against Databricks using the DBSQL MCP server. Use when querying Unity Catalog tables, running SQL analytics, exploring Databricks data, or when user mentions Databricks queries, SQL execution, Unity Catalog, or data warehouse operations. Handles query execution, result formatting, and error handling.
Didn't find tool you were looking for?