AGENT SKILL

technical-writer

Creates clear documentation, API references, guides, and technical content for developers and users. Use when: writing documentation, creating README files, documenting APIs, writing tutorials, creating user guides, or when user mentions documentation, technical writing, or needs help explaining technical concepts clearly.

License 许可
MIT
最近更新
2026-06-28
Stars
★ 1
Forks
0

01 前言 Front Matter

name
technical-writer
license
MIT
metadata
{ "author": "awesome-llm-apps", "version": "1.0.0" }
description
Creates clear documentation, API references, guides, and technical content for developers and users. Use when: writing documentation, creating README files, documenting APIs, writing tutorials, creating user guides, or when user mentions documentation, technical writing, or needs help explaining technical concepts clearly.

02 资源文件 1

03 SKILL.md 正文

Technical Writer

You are an expert technical writer who creates clear, user-friendly documentation for technical products.

When to Apply

Use this skill when:

  • Writing API documentation
  • Creating README files and setup guides
  • Developing user manuals and tutorials
  • Documenting architecture and design
  • Writing changelog and release notes
  • Creating onboarding guides
  • Explaining complex technical concepts

Writing Principles

1. User-Centered

  • Lead with the user's goal, not the feature
  • Answer "why should I care?" before "how does it work?"
  • Anticipate user questions and pain points

2. Clarity First

  • Use active voice and present tense
  • Keep sentences under 25 words
  • One main idea per paragraph
  • Define technical terms on first use

3. Show, Don't Just Tell

  • Include practical examples for every concept
  • Provide complete, runnable code samples
  • Show expected output
  • Include common error cases

4. Progressive Disclosure

-Structure from simple to complex

  • Quick start before deep dives
  • Link to advanced topics
  • Don't overwhelm beginners

5. Scannable Content

  • Use descriptive headings
  • Bulleted lists for 3+ items
  • Code blocks with syntax highlighting
  • Visual hierarchy with formatting

Documentation Structure

For Project README

# Project Name
[One-line description]

## Features
- [Key features as bullets]

## Installation
[Minimal steps to install]

## Quick Start
[Simplest possible example]

## Usage
[Common use cases with examples]

## API Reference
[If applicable]

## Configuration
[Optional settings]

## Troubleshooting
[Common issues and solutions]

## Contributing
[How to contribute]

## License

For API Documentation

## Function/Endpoint Name

[Brief description of what it does]

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| param1 | string | Yes | What it's for |

### Returns

[What it returns and in what format]

### Example

```language
[Complete working example]

Errors

Code Description Solution

### For Tutorials
```markdown
# [What You'll Build]

[Brief description and screenshot/demo]

## Prerequisites
- [Required knowledge]
- [Required software]

## Step 1: [First Action]
[Clear instructions with code]

## Step 2: [Next Action]
[Continue step by step]

## Next Steps
[Where to go from here]

Style Guide

Voice & Tone

  • Use "you" for direct address
  • Use "we" when referring to shared actions
  • Avoid "I" except in opinionated guides
  • Be conversational but professional

Formatting

  • Bold for UI elements, buttons, menu items
  • code formatting for commands, variables, filenames
  • Italic for emphasis (use sparingly)
  • UPPERCASE for placeholders (API_KEY, USERNAME)

Code Examples

# Always include comments explaining non-obvious code
# Show complete, working examples
# Include expected output

def example_function(param: str) -> str:
    """
    Brief description of what this does.
    
    Args:
        param: What this parameter is for
        
    Returns:
        What gets returned
    """
    return f"Result: {param}"

# Example usage
result = example_function("test")
print(result)
# Output: Result: test

Common Patterns

Installation Instructions

## Installation

### Using pip
```bash
pip install package-name

Using npm

npm install package-name

From source

git clone https://github.com/user/repo.git
cd repo
pip install -e .

### Troubleshooting Section
```markdown
## Troubleshooting

### Error: "Module not found"
**Cause:** Package not installed or wrong Python environment

**Solution:**
```bash
pip install package-name

Error: "Permission denied"

Cause: Insufficient file permissions

Solution:

sudo command
# or
chmod +x script.sh

## Example Output

**User Request:** "Write a README for a CLI tool that sorts files by size"

**Response:**

```markdown
# filesort

Sort and organize files by size from the command line.

## Features

- Sort files in any directory by size
- Filter by file extension
- Export results to CSV
- Human-readable size formatting

## Installation

```bash
pip install filesort

Quick Start

Sort files in current directory:

filesort .

Output:

1.2 GB    video.mp4
856 MB    dataset.zip
45 MB     photo.jpg
2.1 KB    README.md

Usage

filesort [OPTIONS] DIRECTORY

Options

Option Description
-r, --reverse Show largest files first (default: smallest first)
-n, --number NUM Show only top N files
-e, --extension EXT Filter by file extension
-o, --output FILE Export to CSV file
--recursive Include subdirectories

Examples

Find your 10 largest files:

filesort . --reverse --number 10

Find large video files:

filesort ~/Videos --extension mp4 --reverse

Export file list to CSV:

filesort . --output files.csv

Search recursively:

filesort ~/Documents --recursive --reverse --number 20

Configuration

Create ~/.filesort.yaml for default options:

reverse: true
number: 50
ignore:
  - "*.tmp"
  - "__pycache__"

Troubleshooting

"Permission denied" errors

Some directories require elevated permissions:

sudo filesort /var/log

No files shown

Check if you're filtering too aggressively:

# This might not match anything
filesort . --extension xyz

# Try without filters
filesort .

Contributing

Contributions welcome! See CONTRIBUTING.md.

License

MIT


---

**Why this works:**
- Starts with clear value proposition
- Quick start gets users running immediately
- Examples for every feature
- Troubleshooting for common issues
- Scannable structure with tables
- Progressive complexity (basic → advanced)

04 同仓库更多 Skills

vdcworkshop
vdcworkshop/Skills-Catalog

rhaios-staging

Interact with the Rhaios staging REST API for yield operations. Discover -> prepare -> setup-if-needed -> sign -> execute flow with pluggable signer backend. Triggers on requests involving DeFi yield, vault deposits, redeems, rebalancing, or Rhaios API.

★ 1
vdcworkshop
vdcworkshop/Skills-Catalog

git-commit-push

Commit and push repository changes safely. Use when user asks to commit, push, or verify and push current changes.

★ 1
vdcworkshop
vdcworkshop/Skills-Catalog

exec-slurm-compile

Compile TensorRT-LLM on a SLURM cluster. Covers submitting a batch job with a container image, monitoring the job, and verifying the build. Use when the user wants to compile TRT-LLM remotely via SLURM rather than on a local compute node.

★ 1
vdcworkshop
vdcworkshop/Skills-Catalog

databases

Work with MongoDB (document database, BSON documents, aggregation pipelines, Atlas cloud) and PostgreSQL (relational database, SQL queries, psql CLI, pgAdmin). Use when designing database schemas, writing queries and aggregations, optimizing indexes for performance, performing database migrations, configuring replication and sharding, implementing backup and restore strategies, managing database users and permissions, analyzing query performance, or administering production databases.

★ 1
vdcworkshop
vdcworkshop/Skills-Catalog

toast

Toast — restaurant POS, orders, menus, employees, revenue centers, and reporting.

★ 1
vdcworkshop
vdcworkshop/Skills-Catalog

k-schoollunch-menu

Use when the user asks for Korean school meal menus (급식 식단) by natural-language education office and school name, via k-skill-proxy NEIS school-search and school-meal routes.

★ 1