Skill 详情

technical_writing

General professional technical documentation guidance.

匹配类型直接匹配已针对技术写作审核

来源brevdev/workshop-build-an-agent外部来源

报告安装量1仅表示受欢迎程度

使用前先检查

自动化审核只检查相关性，不代表安全审查或推荐。使用前请阅读来源中的说明。

在 skills.sh 查看（打开外部页面）在 GitHub 阅读 SKILL.md （打开外部页面）

已保存的来源预览

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 阅读完整来源