developer-docs-audience-research
Research developer documentation audiences by mapping user goals, learning objectives, business goals, developer traits, user questions, personas, user stories, journey maps, and friction logs. Use when planning docs for APIs, SDKs, platforms, CLIs, developer tools, onboarding guides, SaaS docs, or support-heavy docs before writing or restructuring content.
- License 许可
- MIT
- 最近更新
- 2026-11-14
- Stars
- ★ 1.6k
- Forks
- 491
01 前言 Front Matter
- name
- developer-docs-audience-research
- license
- MIT
- metadata
- { "tags": "developer-docs,technical-writing,documentation,user-research,audience-research", "version": "0.1.0", "category": "Writing", "displayName": "Developer Docs Audience Research" }
- description
- Research developer documentation audiences by mapping user goals, learning objectives, business goals, developer traits, user questions, personas, user stories, journey maps, and friction logs. Use when planning docs for APIs, SDKs, platforms, CLIs, developer tools, onboarding guides, SaaS docs, or support-heavy docs before writing or restructuring content.
- compatibility
- Codex, Claude Code, and other Agent Skills-compatible clients.
02 资源文件 4
- 参考文档guidelines.md1.7 KB
- 参考文档references/core/knowledge.md8.7 KB
- 参考文档workflows/define-learning-objectives.md2.3 KB
- 参考文档workflows/map-doc-audience.md2.3 KB
03 SKILL.md 正文
Developer Docs Audience Research
Use this skill to understand who developer documentation is for before planning, writing, or reorganizing docs. It helps agents turn vague audiences into concrete users, goals, questions, journeys, and validation work.
This skill is derived from Jared Bhatti, Zachary Sarah Corleissen, Jen Lambourne, David Nunez, and Heidi Waterhouse's Docs for Developers: An Engineer's Field Guide to Technical Writing, especially Chapter 1, "Understanding your audience." It is expanded with paraphrased guidance from Christopher Gales and the Splunk Documentation Team's The Product Is Docs: Writing Technical Documentation in a Product Development Group, especially Chapter 3, "Audience," Chapter 9, "Learning Objectives," and Chapter 25, "Writing SaaS Documentation." Do not copy book prose into user outputs. Source: https://link.springer.com/book/10.1007/978-1-4842-7217-6
Quick Start
- Load
guidelines.mdto choose the smallest useful reference set. - Start from the user's doc artifact or product surface, not from a generic audience label.
- Identify user goals, learning objectives, business goals, user traits, questions, and missing knowledge.
- Use
workflows/map-doc-audience.mdwhen the user needs a full audience brief. - Mark assumptions and recommend validation through user conversations, support data, analytics, or a friction log.
Default Output
When researching an audience, return:
- Audience snapshot - primary and secondary users, roles, skill level, environment, and constraints.
- Goals - user goals and business goals that the docs must support.
- Learning objective - starting point, destination, and exit criteria when useful.
- User questions - setup, concept, task, API, troubleshooting, and decision questions.
- Research artifacts - audience definition, persona, user story, journey map, or friction log entries when useful.
- Assumptions and gaps - what is inferred versus verified.
- Validation plan - the next interviews, data sources, or product walk-throughs.
Contents
| Need | Start Here |
|---|---|
| Understand audience concepts | references/core/knowledge.md |
| Apply research rules | references/core/knowledge.md |
| See concise examples | references/core/knowledge.md |
| Produce an audience brief | workflows/map-doc-audience.md |
| Define learning objectives | workflows/define-learning-objectives.md |
| Route by task | guidelines.md |
Core Posture
- Treat "developer" as too broad until narrowed by task, context, skill, and environment.
- Separate what users need from what internal teams want to say.
- Distinguish durable audience definitions from specific personas.
- Prefer evidence over assumptions, but preserve assumptions clearly when evidence is not available yet.
- Let audience findings and learning objectives shape content type, order, depth, examples, and success metrics.
04 同仓库更多 Skills
worktable-review-with-annotations
Create, inspect, reply to, update, or resolve situated Worktable annotations. Use when feedback belongs to a Doc section, block, text range, or HTML Doc, or when the user asks to address existing review feedback and coordinate a requested artifact edit.
worktable-find-and-synthesize-context
Find, assess, and synthesize context from Worktable Docs and Records. Use when the user asks what a workspace contains, wants workspace-backed research, needs current facts reconciled across artifacts, or requests a cited synthesis without changing workspace state.
worktable-create-or-update-docs
Create, edit, rename, or maintain narrative Worktable Docs. Use for plans, decisions, briefs, notes, research syntheses, and other durable prose when the user requests a new artifact or a safe update to an existing one.
worktable-create-or-manage-records
Organize repeated structured information as durable Worktable Records. Use for research datasets, inventories, directories, pipelines, trackers, and other collections whose items need identity, fields, filtering, links, validation, or individual updates.
worktable-create-or-manage-interactive-html
Create or improve durable visual and interactive artifacts in Worktable. Use for dashboards, trackers, calculators, mini apps, slide presentations, and other requests that benefit from a polished HTML Doc.
worktable-collaborate-threads
Read, answer, and hand off messages through durable Worktable threads with users or other authenticated participants. Use when the user asks to check addressed messages, reply to a participant, continue a thread, request another agent's help, wait briefly for a response, or watch for comments and messages sent to the agent.