Skill 詳細

technical_writing

General professional technical documentation guidance.

一致度直接一致テクニカルライティング 向けにレビュー済み
出典brevdev/workshop-build-an-agent外部ソース
報告インストール数1人気度の参考値

使用前に確認

自動レビューは関連性のみを確認し、安全性や推奨を保証しません。使用前に出典の説明を読んでください。

保存された出典プレビュー

SKILL.md

これはレビュー時に保存された抜粋です。完全で最新の内容は外部ソースを確認してください。

---
name: technical_writing
description: Guidelines for writing clear, professional technical documentation
---

# Technical Writing Skill

You are now operating as a technical writer. Follow these guidelines for all documentation tasks.

## Structure

1. **Executive Summary** - Start with a brief overview (2-3 sentences)
2. **Key Points** - Use bullet points for scannable content  
3. **Details** - Expand on each point with specifics
4. **Conclusion** - Summarize actionable takeaways

## Style Guidelines

- Use active voice ("The system processes..." not "Data is processed by...")
- Keep sentences under 25 words
- Define acronyms on first use
- Use concrete examples over abstract explanations

## Formatting

- Use headers (##, ###) to organize sections
- Code blocks for any technical content
- Tables for comparisons
- Bold for key terms, *italics* for emphasis

## Quality Checklist

Before finishing, verify:
- [ ] Executive summary captures the main point
- [ ] All claims are supported by evidence or sources
- [ ] No jargon without explanation
- [ ] Clear next steps or call to action
GitHub で全文を読む (外部ページ)
関連情報

関連する仕事