docs-as-marketing

Name: docs-as-marketing
Author: jonathimer

80installs6forks

How to install docs-as-marketing?

jonathimer/devmarketing-skills/docs-as-marketing

$npx -y skills add jonathimer/devmarketing-skills --skill docs-as-marketing

Installs into the current project.

Summary

Transform documentation into a powerful marketing channel that attracts, converts, and retains developers. This skill covers creating documentation that ranks in search, converts visitors into users, and accelerates adoption through exceptional information architecture and develo

Files · 1

View on GitHub

SKILL.md

1	# Documentation as Marketing
2
3	Documentation is often a developer's first meaningful interaction with your product. Great docs don't just explain—they market. They reduce friction, build trust, and turn curious visitors into active users who recommend your product to others.
4
5	## Overview
6
7	Developer documentation serves multiple marketing functions:
8	- Acquisition: Docs rank in search and attract developers actively seeking solutions
9	- Activation: Well-structured quickstarts reduce time-to-value
10	- Retention: Comprehensive references keep developers building
11	- Referral: Developers share docs they love, not marketing pages
12
13	This skill covers the intersection of technical writing and developer marketing—creating documentation that serves both education and conversion goals.
14
15	## Before You Start
16
17	Review the developer-audience-context skill to understand your target developers:
18	- What problems are they searching for solutions to?
19	- What's their technical sophistication level?
20	- What frameworks and languages do they use?
21	- Where do they currently look for answers?
22
23	Your documentation strategy should directly address these audience insights.
24
25	## Information Architecture That Converts
26
27	### The Four Types of Documentation
28
29	Structure your docs around the four types developers need:
30
31	\| Type \| Purpose \| Marketing Function \|
32	\|------\|---------\|-------------------\|
33	\| Tutorials \| Learning-oriented, step-by-step \| Builds confidence, shows product value \|
34	\| How-to Guides \| Task-oriented, problem-solving \| Demonstrates capability breadth \|
35	\| Reference \| Information-oriented, accurate \| Proves product depth and reliability \|
36	\| Explanation \| Understanding-oriented, conceptual \| Establishes thought leadership \|
37
38	### Navigation That Reduces Bounce
39
40	Good Navigation Structure:
41	```
42	Getting Started
43	├── Quickstart (< 5 min)
44	├── Installation
45	└── Core Concepts
46
47	Guides
48	├── Authentication
49	├── [Most Common Use Case]
50	├── [Second Most Common Use Case]
51	└── ...
52
53	API Reference
54	├── Overview
55	├── Authentication
56	├── Endpoints (alphabetical or logical grouping)
57	└── SDKs
58
59	Resources
60	├── Examples
61	├── Changelog
62	└── Support
63	```
64
65	Bad Navigation Structure:
66	```
67	Documentation
68	├── Chapter 1: Introduction
69	├── Chapter 2: Getting Started
70	├── Chapter 3: Advanced Topics
71	├── Appendix A
72	└── API (link to separate site)
73	```
74
75	### Information Hierarchy
76
77	Every documentation page should follow this hierarchy:
78	1. What is this? (1 sentence)
79	2. Why would I use it? (1-2 sentences)
80	3. How do I use it? (the bulk of the page)
81	4. What's next? (clear next steps)
82
83	## Quickstart Optimization
84
85	Your quickstart is your most important conversion page. Optimize ruthlessly.
86
87	### The 5-Minute Rule
88
89	Developers should reach a meaningful success moment within 5 minutes. If your quickstart takes longer, you're losing developers.
90
91	Measure and optimize:
92	- Time from page load to first successful API call
93	- Drop-off points in the quickstart flow
94	- Completion rate
95
96	### Quickstart Structure
97
98	```markdown
99	# Quickstart
100
101	Get your first [meaningful result] in under 5 minutes.
102
103	## Prerequisites
104	- [Specific version] of [language/tool]
105	- [Account/API key] (link to signup)
106
107	## Step 1: Install
108	[Single command, copy-paste ready]
109
110	## Step 2: Configure
111	[Minimal configuration, explain what each part does]
112
113	## Step 3: Run
114	[The payoff—show them it works]
115
116	## What You Built
117	[Explain what just happened and why it matters]
118
119	## Next Steps
120	- [Immediate next tutorial]
121	- [Reference docs for what they just used]
122	- [Community/support link]
123	```
124
125	### Good vs. Bad Quickstarts
126
127	Good Quickstart:
128	```markdown
129	# Send Your First Message
130
131	Send an SMS in under 5 minutes.
132
133	## Prerequisites
134	- Node.js 16 or higher
135	- A Twilio account ([sign up free](link))
136
137	## Install the SDK
138	```bash
139	npm install twilio
140	```
141
142	## Send a Message
143	Create `send-sms.js`:
144	```javascript
145	const twilio = require('twilio');
146	const client = twilio('YOUR_ACCOUNT_SID', 'YOUR_AUTH_TOKEN');
147
148	client.messages.create({
149	body: 'Hello from my app!',
150	to: '+15551234567',
151	from: '+15559876543'
152	}).then(message => console.log(`Sent: ${message.sid}`));
153	```
154
155	Run it:
156	```bash
157	node send-sms.js
158	```
159
160	You should see: `Sent: SM1234...`
161
162	## What Just Happened
163	You authenticated with your API credentials and sent an SMS...
164	```
165
166	Bad Quickstart:
167	```markdown
168	# Getting Started
169
170	Welcome to our platform! Befor

People who liked this also viewed

6 picks

Type

docs-as-marketing

80installs6forks

View on GitHub

How to install docs-as-marketing?

jonathimer/devmarketing-skills/docs-as-marketing

$npx -y skills add jonathimer/devmarketing-skills --skill docs-as-marketing

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# Documentation as Marketing
2
3	Documentation is often a developer's first meaningful interaction with your product. Great docs don't just explain—they market. They reduce friction, build trust, and turn curious visitors into active users who recommend your product to others.
4
5	## Overview
6
7	Developer documentation serves multiple marketing functions:
8	- Acquisition: Docs rank in search and attract developers actively seeking solutions
9	- Activation: Well-structured quickstarts reduce time-to-value
10	- Retention: Comprehensive references keep developers building
11	- Referral: Developers share docs they love, not marketing pages
12
13	This skill covers the intersection of technical writing and developer marketing—creating documentation that serves both education and conversion goals.
14
15	## Before You Start
16
17	Review the developer-audience-context skill to understand your target developers:
18	- What problems are they searching for solutions to?
19	- What's their technical sophistication level?
20	- What frameworks and languages do they use?
21	- Where do they currently look for answers?
22
23	Your documentation strategy should directly address these audience insights.
24
25	## Information Architecture That Converts
26
27	### The Four Types of Documentation
28
29	Structure your docs around the four types developers need:
30
31	\| Type \| Purpose \| Marketing Function \|
32	\|------\|---------\|-------------------\|
33	\| Tutorials \| Learning-oriented, step-by-step \| Builds confidence, shows product value \|
34	\| How-to Guides \| Task-oriented, problem-solving \| Demonstrates capability breadth \|
35	\| Reference \| Information-oriented, accurate \| Proves product depth and reliability \|
36	\| Explanation \| Understanding-oriented, conceptual \| Establishes thought leadership \|
37
38	### Navigation That Reduces Bounce
39
40	Good Navigation Structure:
41	```
42	Getting Started
43	├── Quickstart (< 5 min)
44	├── Installation
45	└── Core Concepts
46
47	Guides
48	├── Authentication
49	├── [Most Common Use Case]
50	├── [Second Most Common Use Case]
51	└── ...
52
53	API Reference
54	├── Overview
55	├── Authentication
56	├── Endpoints (alphabetical or logical grouping)
57	└── SDKs
58
59	Resources
60	├── Examples
61	├── Changelog
62	└── Support
63	```
64
65	Bad Navigation Structure:
66	```
67	Documentation
68	├── Chapter 1: Introduction
69	├── Chapter 2: Getting Started
70	├── Chapter 3: Advanced Topics
71	├── Appendix A
72	└── API (link to separate site)
73	```
74
75	### Information Hierarchy
76
77	Every documentation page should follow this hierarchy:
78	1. What is this? (1 sentence)
79	2. Why would I use it? (1-2 sentences)
80	3. How do I use it? (the bulk of the page)
81	4. What's next? (clear next steps)
82
83	## Quickstart Optimization
84
85	Your quickstart is your most important conversion page. Optimize ruthlessly.
86
87	### The 5-Minute Rule
88
89	Developers should reach a meaningful success moment within 5 minutes. If your quickstart takes longer, you're losing developers.
90
91	Measure and optimize:
92	- Time from page load to first successful API call
93	- Drop-off points in the quickstart flow
94	- Completion rate
95
96	### Quickstart Structure
97
98	```markdown
99	# Quickstart
100
101	Get your first [meaningful result] in under 5 minutes.
102
103	## Prerequisites
104	- [Specific version] of [language/tool]
105	- [Account/API key] (link to signup)
106
107	## Step 1: Install
108	[Single command, copy-paste ready]
109
110	## Step 2: Configure
111	[Minimal configuration, explain what each part does]
112
113	## Step 3: Run
114	[The payoff—show them it works]
115
116	## What You Built
117	[Explain what just happened and why it matters]
118
119	## Next Steps
120	- [Immediate next tutorial]
121	- [Reference docs for what they just used]
122	- [Community/support link]
123	```
124
125	### Good vs. Bad Quickstarts
126
127	Good Quickstart:
128	```markdown
129	# Send Your First Message
130
131	Send an SMS in under 5 minutes.
132
133	## Prerequisites
134	- Node.js 16 or higher
135	- A Twilio account ([sign up free](link))
136
137	## Install the SDK
138	```bash
139	npm install twilio
140	```
141
142	## Send a Message
143	Create `send-sms.js`:
144	```javascript
145	const twilio = require('twilio');
146	const client = twilio('YOUR_ACCOUNT_SID', 'YOUR_AUTH_TOKEN');
147
148	client.messages.create({
149	body: 'Hello from my app!',
150	to: '+15551234567',
151	from: '+15559876543'
152	}).then(message => console.log(`Sent: ${message.sid}`));
153	```
154
155	Run it:
156	```bash
157	node send-sms.js
158	```
159
160	You should see: `Sent: SM1234...`
161
162	## What Just Happened
163	You authenticated with your API credentials and sent an SMS...
164	```
165
166	Bad Quickstart:
167	```markdown
168	# Getting Started
169
170	Welcome to our platform! Befor

People who liked this also viewed

6 picks

Type