custom-plugin-technical-writer

内容来源：README.md（说明文档） · 原始地址 · 查看安装指南

原始内容

<div align="center">

<!-- Animated Typing Banner -->
<img src="https://readme-typing-svg.demolab.com?font=Fira+Code&weight=600&size=28&duration=3000&pause=1000&color=2E9EF7&center=true&vCenter=true&multiline=true&repeat=true&width=600&height=100&lines=Technical+Writer+Assistant;1+Agents+%7C+3+Skills;Claude+Code+Plugin" alt="Technical Writer Assistant" />

<br/>

<!-- Badge Row 1: Status Badges -->
[![Version](https://img.shields.io/badge/Version-1.0.0-blue?style=for-the-badge)](https://github.com/pluginagentmarketplace/custom-plugin-technical-writer/releases)
[![License](https://img.shields.io/badge/License-Custom-yellow?style=for-the-badge)](LICENSE)
[![Status](https://img.shields.io/badge/Status-Production-brightgreen?style=for-the-badge)](#)
[![SASMP](https://img.shields.io/badge/SASMP-v1.3.0-blueviolet?style=for-the-badge)](#)

<!-- Badge Row 2: Content Badges -->
[![Agents](https://img.shields.io/badge/Agents-1-orange?style=flat-square&logo=robot)](#-agents)
[![Skills](https://img.shields.io/badge/Skills-3-purple?style=flat-square&logo=lightning)](#-skills)
[![Commands](https://img.shields.io/badge/Commands-4-green?style=flat-square&logo=terminal)](#-commands)

<br/>

<!-- Quick CTA Row -->
[📦 **Install Now**](#-quick-start) · [🤖 **Explore Agents**](#-agents) · [📖 **Documentation**](#-documentation) · [⭐ **Star this repo**](https://github.com/pluginagentmarketplace/custom-plugin-technical-writer)

---

### What is this?

> **Technical Writer Assistant** is a Claude Code plugin with **1 agents** and **3 skills** for technical writer development.

</div>

---

## 📑 Table of Contents

<details>
<summary>Click to expand</summary>

- [Quick Start](#-quick-start)
- [Features](#-features)
- [Agents](#-agents)
- [Skills](#-skills)
- [Commands](#-commands)
- [Documentation](#-documentation)
- [Contributing](#-contributing)
- [License](#-license)

</details>

---

## 🚀 Quick Start

### Prerequisites

- Claude Code CLI v2.0.27+
- Active Claude subscription

### Installation (Choose One)

<details open>
<summary><strong>Option 1: From Marketplace (Recommended)</strong></summary>

```bash
# Step 1️⃣ Add the marketplace
/plugin marketplace add pluginagentmarketplace/custom-plugin-technical-writer

# Step 2️⃣ Install the plugin
/plugin install custom-plugin-technical-writer@pluginagentmarketplace-technical-writer

# Step 3️⃣ Restart Claude Code
# Close and reopen your terminal/IDE
```

</details>

<details>
<summary><strong>Option 2: Local Installation</strong></summary>

```bash
# Clone the repository
git clone https://github.com/pluginagentmarketplace/custom-plugin-technical-writer.git
cd custom-plugin-technical-writer

# Load locally
/plugin load .

# Restart Claude Code
```

</details>

### ✅ Verify Installation

After restart, you should see these agents:

```
custom-plugin-technical-writer:technical-writer-specialist
```

---

## ✨ Features

| Feature | Description |
|---------|-------------|
| 🤖 **1 Agents** | Specialized AI agents for technical writer tasks |
| 🛠️ **3 Skills** | Reusable capabilities with Golden Format |
| ⌨️ **4 Commands** | Quick slash commands |
| 🔄 **SASMP v1.3.0** | Full protocol compliance |

---

## 🤖 Agents

### 1 Specialized Agents

| # | Agent | Purpose |
|---|-------|---------|
| 1 | **technical-writer-specialist** | Expert technical writer specializing in API documentation, u |

---

## 🛠️ Skills

### Available Skills

| Skill | Description | Invoke |
|-------|-------------|--------|
| `guides` | Create clear, comprehensive user guides and tutorials includ | `Skill("custom-plugin-technical-writer:guides")` |
| `examples` | Generate clear, well-documented code examples, implementatio | `Skill("custom-plugin-technical-writer:examples")` |
| `api-docs` | Master API documentation creation including OpenAPI/Swagger  | `Skill("custom-plugin-technical-writer:api-docs")` |

---

## ⌨️ Commands

| Command | Description |
|---------|-------------|
| `/api-template` | template - OpenAPI/Swagger Template Generator |
| `/review-docs` | docs - Documentation Review & Improvement |
| `/generate-examples` | examples - Code Example Generator |
| `/write-docs` | docs - Documentation Project Assistant |

---

## 📚 Documentation

| Document | Description |
|----------|-------------|
| [CHANGELOG.md](https://github.com/pluginagentmarketplace/custom-plugin-technical-writer/blob/HEAD/CHANGELOG.md) | Version history |
| [CONTRIBUTING.md](https://github.com/pluginagentmarketplace/custom-plugin-technical-writer/blob/HEAD/CONTRIBUTING.md) | How to contribute |
| [LICENSE](https://github.com/pluginagentmarketplace/custom-plugin-technical-writer/tree/HEAD/LICENSE) | License information |

---

## 📁 Project Structure

<details>
<summary>Click to expand</summary>

```
custom-plugin-technical-writer/
├── 📁 .claude-plugin/
│   ├── plugin.json
│   └── marketplace.json
├── 📁 agents/              # 1 agents
├── 📁 skills/              # 3 skills (Golden Format)
├── 📁 commands/            # 4 commands
├── 📁 hooks/
├── 📄 README.md
├── 📄 CHANGELOG.md
└── 📄 LICENSE
```

</details>

---

## 📅 Metadata

| Field | Value |
|-------|-------|
| **Version** | 1.0.0 |
| **Last Updated** | 2025-12-29 |
| **Status** | Production Ready |
| **SASMP** | v1.3.0 |
| **Agents** | 1 |
| **Skills** | 3 |
| **Commands** | 4 |

---

## 🤝 Contributing

Contributions are welcome! Please read our [Contributing Guide](https://github.com/pluginagentmarketplace/custom-plugin-technical-writer/blob/HEAD/CONTRIBUTING.md).

1. Fork the repository
2. Create your feature branch
3. Follow the Golden Format for new skills
4. Submit a pull request

---

## ⚠️ Security

> **Important:** This repository contains third-party code and dependencies.
>
> - ✅ Always review code before using in production
> - ✅ Check dependencies for known vulnerabilities
> - ✅ Follow security best practices
> - ✅ Report security issues privately via [Issues](https://github.com/pluginagentmarketplace/custom-plugin-technical-writer/tree/HEAD/../../issues)

---

## 📝 License

Copyright © 2025 **Dr. Umit Kacar** & **Muhsin Elcicek**

Custom License - See [LICENSE](https://github.com/pluginagentmarketplace/custom-plugin-technical-writer/tree/HEAD/LICENSE) for details.

---

## 👥 Contributors

<table>
<tr>
<td align="center">
<strong>Dr. Umit Kacar</strong><br/>
Senior AI Researcher & Engineer
</td>
<td align="center">
<strong>Muhsin Elcicek</strong><br/>
Senior Software Architect
</td>
</tr>
</table>

---

<div align="center">

**Made with ❤️ for the Claude Code Community**

[![GitHub](https://img.shields.io/badge/GitHub-pluginagentmarketplace-black?style=for-the-badge&logo=github)](https://github.com/pluginagentmarketplace)

</div>

📦 Install Now · 🤖 Explore Agents · 📖 Documentation · ⭐ Star this repo

What is this?

Technical Writer Assistant is a Claude Code plugin with 1 agents and 3 skills for technical writer development.

📑 Table of Contents

Click to expand

Quick Start
Features
Agents
Skills
Commands
Documentation
Contributing
License

🚀 Quick Start

Prerequisites

Claude Code CLI v2.0.27+
Active Claude subscription

Installation (Choose One)

Option 1: From Marketplace (Recommended)

# Step 1️⃣ Add the marketplace
/plugin marketplace add pluginagentmarketplace/custom-plugin-technical-writer

# Step 2️⃣ Install the plugin
/plugin install custom-plugin-technical-writer@pluginagentmarketplace-technical-writer

# Step 3️⃣ Restart Claude Code
# Close and reopen your terminal/IDE

Option 2: Local Installation

# Clone the repository
git clone https://github.com/pluginagentmarketplace/custom-plugin-technical-writer.git
cd custom-plugin-technical-writer

# Load locally
/plugin load .

# Restart Claude Code

✅ Verify Installation

After restart, you should see these agents:

custom-plugin-technical-writer:technical-writer-specialist

✨ Features

Feature	Description
🤖 1 Agents	Specialized AI agents for technical writer tasks
🛠️ 3 Skills	Reusable capabilities with Golden Format
⌨️ 4 Commands	Quick slash commands
🔄 SASMP v1.3.0	Full protocol compliance

🤖 Agents

1 Specialized Agents

#	Agent	Purpose
1	technical-writer-specialist	Expert technical writer specializing in API documentation, u

🛠️ Skills

Available Skills

Skill	Description	Invoke
`guides`	Create clear, comprehensive user guides and tutorials includ	`Skill("custom-plugin-technical-writer:guides")`
`examples`	Generate clear, well-documented code examples, implementatio	`Skill("custom-plugin-technical-writer:examples")`
`api-docs`	Master API documentation creation including OpenAPI/Swagger	`Skill("custom-plugin-technical-writer:api-docs")`

⌨️ Commands

Command	Description
`/api-template`	template - OpenAPI/Swagger Template Generator
`/review-docs`	docs - Documentation Review & Improvement
`/generate-examples`	examples - Code Example Generator
`/write-docs`	docs - Documentation Project Assistant

📚 Documentation

Document	Description
CHANGELOG.md	Version history
CONTRIBUTING.md	How to contribute
LICENSE	License information

📁 Project Structure

Click to expand

custom-plugin-technical-writer/
├── 📁 .claude-plugin/
│   ├── plugin.json
│   └── marketplace.json
├── 📁 agents/              # 1 agents
├── 📁 skills/              # 3 skills (Golden Format)
├── 📁 commands/            # 4 commands
├── 📁 hooks/
├── 📄 README.md
├── 📄 CHANGELOG.md
└── 📄 LICENSE

📅 Metadata

Field	Value
Version	1.0.0
Last Updated	2025-12-29
Status	Production Ready
SASMP	v1.3.0
Agents	1
Skills	3
Commands	4

🤝 Contributing

Contributions are welcome! Please read our Contributing Guide.

Fork the repository
Create your feature branch
Follow the Golden Format for new skills
Submit a pull request

⚠️ Security

Important: This repository contains third-party code and dependencies.

✅ Always review code before using in production

✅ Check dependencies for known vulnerabilities

✅ Follow security best practices

✅ Report security issues privately via Issues

📝 License

Custom License - See LICENSE for details.

👥 Contributors

Dr. Umit Kacar
Senior AI Researcher & Engineer

Muhsin Elcicek
Senior Software Architect

Made with ❤️ for the Claude Code Community