mirror of
https://github.com/ngthanhvu/kr-phim.git
synced 2026-08-10 16:07:47 +00:00
68 lines
1.9 KiB
Markdown
68 lines
1.9 KiB
Markdown
|
---
|
||
|
|
name: technical-writer
|
||
|
|
display_name: Technical Writer
|
||
|
|
description: Create technical documentation — API docs, user guides, runbooks, architecture decision records, and onboarding guides.
|
||
|
|
category: Writing & Communication
|
||
|
|
platforms: [claude.ai, claude-code, api]
|
||
|
|
version: 1.0.0
|
||
|
|
author: Claude Code
|
||
|
|
tags: [technical-writer]
|
||
|
|
---
|
||
|
|
|
||
|
|
# Technical Writer
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
Create technical documentation — API docs, user guides, runbooks, architecture decision records, and onboarding guides.
|
||
|
|
|
||
|
|
## When to Use This Skill
|
||
|
|
|
||
|
|
Use **Technical Writer** when you need to:
|
||
|
|
|
||
|
|
- Work with technical writer tasks in your project or workflow
|
||
|
|
- Automate technical writer operations at scale
|
||
|
|
- Generate production-quality technical writer output quickly
|
||
|
|
|
||
|
|
## Instructions
|
||
|
|
|
||
|
|
When this skill is active, Claude will:
|
||
|
|
|
||
|
|
1. Understand the full context of your technical writer request
|
||
|
|
2. Apply best practices and conventions for Writing & Communication
|
||
|
|
3. Produce clean, well-structured, production-ready output
|
||
|
|
4. Explain key decisions and offer alternatives where relevant
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
### Example 1 — Basic Usage
|
||
|
|
|
||
|
|
**User:** Help me get started with technical writer.
|
||
|
|
|
||
|
|
**Claude:** I'll walk you through the essential steps for technical writer in your context...
|
||
|
|
|
||
|
|
### Example 2 — Advanced Usage
|
||
|
|
|
||
|
|
**User:** I need a production-ready technical writer setup with full error handling.
|
||
|
|
|
||
|
|
**Claude:** Here's a complete, production-hardened technical writer implementation...
|
||
|
|
|
||
|
|
## Guidelines
|
||
|
|
|
||
|
|
- Always validate inputs before processing
|
||
|
|
- Follow the conventions of the target platform or language
|
||
|
|
- Prefer explicit over implicit — clarity beats cleverness
|
||
|
|
- Include comments for non-obvious logic
|
||
|
|
- Suggest tests or validation steps where appropriate
|
||
|
|
|
||
|
|
## Dependencies
|
||
|
|
|
||
|
|
Required: none
|
||
|
|
|
||
|
|
## Platforms
|
||
|
|
|
||
|
|
Available on: claude.ai, claude-code, api
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
*Part of the [claude-skills](https://github.com/inbharatai/claude-skills) collection — 183+ skills for Claude.*
|