developer-docs-technical-research
Installation
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
- Load
guidelines.mdto choose the smallest useful reference set. - State the documentation question, audience, feature, release context, and risk.
- Build a source map from code, product surfaces, specs, tickets, SMEs, QA, support, and existing docs.
- Use
workflows/research-feature-docs.mdwhen feature behavior or user consequences are unclear. - Use
workflows/interview-doc-sources.mdwhen the main work is extracting facts from SMEs. - Return verified facts, assumptions, contradictions, source owners, and open questions.
Default Output
When completing a documentation research pass, return: