Detalle del Skill

technical_writing

General professional technical documentation guidance.

CoincidenciaDirectaRevisado para redacción técnica
Fuentebrevdev/workshop-build-an-agentFuente externa
Instalaciones reportadas1Solo señal de popularidad

Revisar antes de usar

La revisión automática comprueba relevancia, no seguridad ni respaldo. Lee las instrucciones de la fuente antes de usar este Skill.

Vista previa guardada

SKILL.md

Este extracto es una copia guardada durante la revisión. La fuente externa contiene la versión completa y actual.

---
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
Leer la fuente completa en GitHub (abre una página externa)
Contexto

Trabajo relacionado