Documentação como Marketing

Quando Usar

Use esta habilidade quando precisar transformar a documentação em um canal de marketing poderoso que atrai, converte e retém desenvolvedores. Esta habilidade abrange a criação de documentação que ranqueia em buscas, converte visitantes em usuários e acelera a adoção através de uma arquitetura de informação excepcional e...

A documentação é frequentemente a primeira interação significativa de um desenvolvedor com seu produto. Documentos excelentes não apenas explicam, eles vendem. Eles reduzem o atrito, constroem confiança e transformam visitantes curiosos em usuários ativos que recomendam seu produto a outros.

Visão Geral

A documentação para desenvolvedores serve a múltiplas funções de marketing:

• Aquisição: Documentos ranqueiam em buscas e atraem desenvolvedores que buscam ativamente soluções.
• Ativação: Quickstarts bem estruturados reduzem o tempo para obter valor.
• Retenção: Referências abrangentes mantêm os desenvolvedores construindo.
• Indicação: Desenvolvedores compartilham documentos que amam, não páginas de marketing.

Esta habilidade abrange a intersecção entre escrita técnica e marketing para desenvolvedores — criando documentação que atende tanto a objetivos de educação quanto de conversão.

Antes de Começar

Revise a habilidade developer-audience-context para entender seus desenvolvedores-alvo:

• Para quais problemas eles estão buscando soluções?
• Qual o nível de sofisticação técnica deles?
• Quais frameworks e linguagens eles usam?
• Onde eles buscam respostas atualmente?

Sua estratégia de documentação deve abordar diretamente essas percepções sobre o público.

Arquitetura de Informação Que Converte

Os Quatro Tipos de Documentação

Estruture seus documentos em torno dos quatro tipos que os desenvolvedores precisam:

Navegação Que Reduz o Bounce

Boa Estrutura de Navegação:

Getting Started
├── Quickstart (< 5 min)
├── Installation
└── Core Concepts

Guides
├── Authentication
├── [Most Common Use Case]
├── [Second Most Common Use Case]
└── ...

API Reference
├── Overview
├── Authentication
├── Endpoints (alphabetical or logical grouping)
└── SDKs

Resources
├── Examples
├── Changelog
└── Support

Má Estrutura de Navegação:

Documentation
├── Chapter 1: Introduction
├── Chapter 2: Getting Started
├── Chapter 3: Advanced Topics
├── Appendix A
└── API (link to separate site)

Hierarquia de Informação

Cada página de documentação deve seguir esta hierarquia:

1. O quê é isso? (1 frase)
2. Por que eu usaria isso? (1-2 frases)
3. Como eu uso isso? (a maior parte da página)
4. E agora? (próximos passos claros)

Otimização de Quickstart

Seu quickstart é sua página de conversão mais importante. Otimize implacavelmente.

A Regra dos 5 Minutos

Os desenvolvedores devem atingir um momento de sucesso significativo em até 5 minutos. Se o seu quickstart demorar mais, você está perdendo desenvolvedores.

Meça e otimize:

• Tempo da carga da página até a primeira chamada de API bem-sucedida
• Pontos de abandono no fluxo do quickstart
• Taxa de conclusão

Estrutura do Quickstart

# Quickstart

Get your first [meaningful result] in under 5 minutes.

## Prerequisites
- [Specific version] of [language/tool]
- [Account/API key] (link to signup)

## Step 1: Install
[Single command, copy-paste ready]

## Step 2: Configure
[Minimal configuration, explain what each part does]

## Step 3: Run
[The payoff—show them it works]

## What You Built
[Explain what just happened and why it matters]

## Next Steps
- [Immediate next tutorial]
- [Reference docs for what they just used]
- [Community/support link]

Quickstarts Bons vs. Ruins

Quickstart Bom:

# Send Your First Message

Send an SMS in under 5 minutes.

## Prerequisites
- Node.js 16 or higher
- A Twilio account ([sign up free](https://github.com/jonathimer/devmarketing-skills/tree/main/skills/docs-as-marketing/link))

## Install the SDK
```bash
npm install twilio

Send a Message

Create send-sms.js:

const twilio = require('twilio');
const client = twilio('YOUR_ACCOUNT_SID', 'YOUR_AUTH_TOKEN');

client.messages.create({
  body: 'Hello from my app!',
  to: '+15551234567',
  from: '+15559876543'

…