AGENT SKILL

developer-docs-technical-research

Research product and feature facts for developer documentation by mapping source-of-truth owners, validating behavior hands-on, interviewing SMEs, and turning uncertainty into doc-ready notes. Use when feature specs are incomplete, implementation details need user-facing meaning, SMEs disagree, or docs require evidence before planning, drafting, release notes, API docs, tutorials, scenarios, or troubleshooting content.

License 许可
MIT
最近更新
2026-11-14
Stars
★ 1.6k
Forks
491

01 前言 Front Matter

name
developer-docs-technical-research
license
MIT
metadata
{ "tags": "developer-docs,technical-writing,documentation,research,sme-interviews", "version": "0.1.0", "category": "Writing", "displayName": "Developer Docs Technical Research" }
description
Research product and feature facts for developer documentation by mapping source-of-truth owners, validating behavior hands-on, interviewing SMEs, and turning uncertainty into doc-ready notes. Use when feature specs are incomplete, implementation details need user-facing meaning, SMEs disagree, or docs require evidence before planning, drafting, release notes, API docs, tutorials, scenarios, or troubleshooting content.
compatibility
Codex, Claude Code, and other Agent Skills-compatible clients.

02 资源文件 4

03 SKILL.md 正文

Developer Docs Technical Research

Use this skill to investigate product behavior before planning or writing developer documentation. It turns specs, code, prototypes, tickets, SMEs, and hands-on tests into traceable research notes.

This skill is derived from paraphrased guidance in Christopher Gales and the Splunk Documentation Team's The Product Is Docs: Writing Technical Documentation in a Product Development Group, especially Chapter 13, "Research for Technical Writers," Chapter 16, "Technical Verification," Chapter 19, "Working with Engineers," and Chapter 22, "Working with Product Management." 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. State the documentation question, audience, feature, release context, and risk.
  3. Build a source map from code, product surfaces, specs, tickets, SMEs, QA, support, and existing docs.
  4. Use workflows/research-feature-docs.md when feature behavior or user consequences are unclear.
  5. Use workflows/interview-doc-sources.md when the main work is extracting facts from SMEs.
  6. Return verified facts, assumptions, contradictions, source owners, and open questions.

Default Output

When completing a documentation research pass, return:

  1. Research brief - doc question, audience, scope, and decision needed.
  2. Verified facts - behavior, limits, defaults, prerequisites, permissions, errors, and examples with source.
  3. User consequences - what readers can do, decide, risk, or misunderstand.
  4. Source map - authoritative owner or artifact for each important fact.
  5. Contradictions and gaps - unresolved disagreements, missing access, or untested behavior.
  6. Recommended docs action - plan, draft, defer, file product issue, or request review.

Contents

Need Start Here
Understand technical research concepts references/core/knowledge.md
Build a feature research plan workflows/research-feature-docs.md
Interview engineers, PMs, QA, support, or field teams workflows/interview-doc-sources.md
Route by task or symptom guidelines.md

Core Posture

  • Research user-facing consequences, not only implementation.
  • Verify directly when the product, API, CLI, UI, or environment is available.
  • Treat named owners and durable artifacts as the source of truth.
  • Keep uncertainty visible until it is resolved.
  • File product or UX defects when documentation would be forced to explain avoidable confusion.

04 同仓库更多 Skills

hashgraph-online
hashgraph-online/awesome-codex-plugins

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.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

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.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

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.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

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.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

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.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

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.

★ 1.6k