跳到主要内容
知仓学习社ZHICANG

developer-docs-audience-research

Research developer documentation audiences by mapping user goals, learning objectives, business goals, developer traits, user questions, personas, u…

不碰外部(只输出文字)无严重或高危命中hashgraph-online/awesome-codex-plugins

它会碰到什么

扫了多少5 个文本文件,19 KB
它会碰到什么不碰外部(只输出文字)
命中总数0 处
命中统计严重 0 · 高 0 · 中 0 · 低 0

这一栏是扫描器报的事实,不是结论。命中多不等于有毒(安全工具、规则库、示例脚本本来就会包含危险写法),命中少也不等于干净。它和你手上的凭据、文件、网络有什么关系,需要你自己看。

技能内容

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

  1. Load guidelines.md to choose the smallest useful reference set.
  2. Start from the user's doc artifact or product surface, not from a generic audience label.
  3. Identify user goals, learning objectives, business goals, user traits, questions, and missing knowledge.
  4. Use workflows/map-doc-audience.md when the user needs a full audience brief.
  5. Mark assumptions and recommend validation through user conversations, support data, analytics, or a friction log.

Default Output

When researching an audience, return:

  1. Audience snapshot - primary and secondary users, roles, skill level, environment, and constraints.
  2. Goals - user goals and business goals that the docs must support.
  3. Learning objective - starting point, destination, and exit criteria when useful.
  4. User questions - setup, concept, task, API, troubleshooting, and decision questions.
  5. Research artifacts - audience definition, persona, user story, journey map, or friction log entries when useful.
  6. Assumptions and gaps - what is inferred versus verified.
  7. 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.

想直接用这个技能?

本站把开放许可(MIT / Apache 等)的技能按仓库打包整理到网盘,点一下转存到你自己的网盘,不用一个个从 GitHub 拉。许可未声明的技能只给原始仓库链接,不打包。

它属于哪个仓库

星标★ 1,027
本站分层T1
该仓技能数1910
原文件路径plugins/LVTD-LLC/skills/skills/developer-docs-audience-research/SKILL.md

同一个仓库里的其他技能

看这个仓库的全部 1910 个技能