Get the FREE Ultimate OpenClaw Setup Guide →

ln-002-best-practices-researcher

npx machina-cli add skill levnikolaevich/claude-code-skills/ln-002-best-practices-researcher --openclaw
Files (1)
SKILL.md
8.3 KB

Paths: File paths (shared/, references/, ../ln-*) are relative to skills repo root. If not found at CWD, locate this SKILL.md directory and go up one level for repo root.

Best Practices Researcher

Research industry standards and create project documentation in one workflow.

Purpose & Scope

  • Research via MCP Ref + Context7 for standards, patterns, versions
  • Create 4 types of documents from research results:
    • Guide: Pattern documentation (Do/Don't/When table)
    • Manual: API reference (methods/params/doc links)
    • ADR: Architecture Decision Record (Q&A dialog)
    • Research: Investigation document answering specific question
  • Return document path for linking in Stories/Tasks

Phase 0: Stack Detection

Objective: Identify project stack to filter research queries and adapt output.

Detection:

IndicatorStackQuery PrefixOfficial Docs
*.csproj, *.sln.NET"C# ASP.NET Core"Microsoft docs
package.json + tsconfig.jsonNode.js"TypeScript Node.js"MDN, npm docs
requirements.txt, pyproject.tomlPython"Python"Python docs, PyPI
go.modGo"Go Golang"Go docs
Cargo.tomlRust"Rust"Rust docs
build.gradle, pom.xmlJava"Java"Oracle docs, Maven

Usage:

  • Add query_prefix to all MCP search queries
  • Link to stack-appropriate official docs

When to Use

  • ln-310-story-validator detects missing documentation
  • Need to document a pattern, library, or decision
  • Replaces: ln-321-guide-creator, ln-322-adr-creator, ln-323-manual-creator

Input Parameters

ParameterRequiredDescription
doc_typeYes"guide" / "manual" / "adr" / "research"
topicYesWhat to document (pattern name, package name, decision title, research question)
story_contextNoStory/Task context for relevance

Research Tools

ToolUse CaseQuery Pattern
ref_search_documentationStandards, patterns, RFCs"[topic] RFC standard best practices {current_year}"
context7__resolve-library-idGet library ID for docslibraryName="[topic]"
context7__query-docsLibrary API, methodstopic="[stack_prefix] [topic]"
WebSearchMarket, competitors, versions"[topic] latest {current_year}" or "[topic] vs alternatives"

Time-box: 5-10 minutes for research; skip if topic is trivial

Research Methodology by Type (for doc_type="research")

TypeFocusPrimary SourcesKey Questions
TechnicalSolution comparisonDocs, benchmarks, RFCs"Which solution fits our use-case?"
MarketIndustry landscapeReports, blogs, articles"What's the market size/trend?"
CompetitorHow others solve itProduct pages, reviews, demos"What features do competitors offer?"
RequirementsUser needsFeedback, support tickets, forums"What do customers complain about?"
FeasibilityCan we build it?PoC, prototypes, local tests"Is it technically possible?"
Feature DemandFeature viabilityCompetitor features + blogs/socials + user complaints"Is this feature worth building?"

Workflow

doc_typePurposeResearch SourceTemplateOutput PathWords
guidePattern with Do/Don't/When tableref_search (best practices)guide_template.mdguides/NN-[slug].md300-500
manualAPI/library referencecontext7__query-docsmanual_template.mdmanuals/[pkg]-[ver].md300-500
adrArchitecture decisionDialog (5 questions)adr_template.mdadrs/adr-NNN-[slug].md300-500
researchInvestigation answering questionSee Methodology table aboveresearch_template.mdresearch/rsh-NNN-[slug].md300-700

Common Workflow: Detect number (if needed) → Research → Generate from template → Validate (SCOPE, POSIX) → Save → Return path

Extract & Sections by doc_type:

  • guide: Extract principle, 2-3 do/don'ts, sources → Sections: Principle, Our Implementation, Patterns table, Sources, Related
  • manual: Extract methods, params (type/required/default), returns → Sections: Package info, Overview, Methods table, Config table, Limitations
  • adr: Dialog answers → Sections: Context, Decision, Rationale, Alternatives table, Consequences, Related
  • research: Findings by methodology → Sections: Question, Context, Methodology, Findings (tables!), Conclusions, Next Steps, Sources

Validation specifics: guide: patterns table present; manual: version in filename; adr: ISO date, status field; all: sources ≤ 1 year old

ADR Dialog (5 questions): Q1: Title? → Q2: Category (Strategic/Technical)? → Q3: Context? → Q4: Decision + Rationale? → Q5: Alternatives (2 with pros/cons)?

Output: File path for linking in Stories/Tasks; for ADR remind to reference in architecture.md; for Research suggest ADR if decision needed

Critical Rules

MANDATORY FILE CREATION:

  • ALL research MUST end with file creation (guide/manual/ADR/research document)
  • Create target directory if missing (docs/guides/, docs/manuals/, docs/adrs/, docs/research/)
  • No exceptions — file creation is required for ALL invocations

NO_CODE_EXAMPLES (ALL document types):

ForbiddenAllowed
Code snippetsTables (params, config, alternatives)
Implementation examplesASCII diagrams, Mermaid diagrams
Code blocks >1 lineMethod signatures (1 line inline)
Links to official docs

Format Priority (STRICT):

┌───────────────────────────────────────────────┐
│ 1. TABLES + ASCII diagrams  ←── PRIORITY      │
│    Params, Config, Alternatives, Flows        │
├───────────────────────────────────────────────┤
│ 2. LISTS (enumerations only)                  │
│    Enumeration items, file lists, tools       │
├───────────────────────────────────────────────┤
│ 3. TEXT (last resort)                         │
│    Only if cannot express as table            │
└───────────────────────────────────────────────┘
Content TypeFormat
ParametersTable: Name | Type | Required | Default
ConfigurationTable: Option | Type | Default | Description
AlternativesTable: Alt | Pros | Cons | Why Rejected
PatternsTable: Do | Don't | When
WorkflowASCII diagram: A → B → C

Other Rules:

  • Research ONCE per invocation; reuse results
  • Cite sources with versions/dates (≤ 1 year old)
  • One pattern per guide; one decision per ADR; one package per manual
  • Preserve language (EN/RU) from story_context
  • Link to stack-appropriate docs (Microsoft for .NET, MDN for JS, etc.)
  • MANDATORY: Create target directory if missing (docs/guides/, docs/manuals/, docs/adrs/, docs/research/); file creation is required

Definition of Done

  • Research completed (standards/patterns/versions extracted) - for guide/manual
  • Dialog completed (5 questions answered) - for ADR
  • Document generated with all required sections; no placeholders
  • Standards validated (SCOPE, maintenance, POSIX)
  • File saved to correct directory with proper naming
  • Path returned; README updated if placeholder present

Reference Files

  • Guide template: shared/templates/guide_template.md
  • Manual template: shared/templates/manual_template.md
  • ADR template: shared/templates/adr_template.md
  • Research template: shared/templates/research_template.md
  • Standards: docs/DOCUMENTATION_STANDARDS.md (if exists)

Version: 3.0.1 Last Updated: 2026-02-14

Source

git clone https://github.com/levnikolaevich/claude-code-skills/blob/master/ln-002-best-practices-researcher/SKILL.mdView on GitHub

Overview

Best Practices Researcher uses MCP Ref and Context7 to surface standards, patterns, and versions. It then synthesizes findings into four deliverables: a Guide (pattern documentation), a Manual (API reference), an ADR (architecture decision), and a Research document, with output paths returned for linking in Stories/Tasks.

How This Skill Works

It detects the project stack to tailor research queries, then runs MCP Ref, Context7, and WebSearch to collect standards and docs. It renders four documents from templates (guide_template.md, manual_template.md, adr_template.md, and research_template.md) into designated paths and returns their locations for linking in stories and tasks.

When to Use It

  • Document a repeatable pattern or architecture decision (pattern/standards) that needs formal guidance.
  • Create API/reference material for a library, package, or service.
  • Capture an Architecture Decision (ADR) with a Q&A format from research.
  • Answer a research question with both explanatory and reference docs.
  • Generate multiple output types from a single research pass and link them to Stories/Tasks.

Quick Start

  1. Step 1: Trigger with doc_type (guide/manual/adr/research) and topic; include optional story_context.
  2. Step 2: Review outputs at guides/NN-*.md, manuals/*-*.md, adrs/*.md, and research/*.md.
  3. Step 3: Link the generated paths to the corresponding Story/Task in your project.

Best Practices

  • Phase 0 stack detection to tailor queries and outputs.
  • Always use query_prefix on MCP search queries to target the right stack.
  • Source primarily from official docs, RFCs, and standards via MCP Ref, Context7, and WebSearch.
  • Render outputs using the designated templates and aim for ~300-500 words per document.
  • Return output paths (guides/, manuals/, adrs/, research/) for easy linking in Stories/Tasks.

Example Use Cases

  • guides/NN-auth-pattern.md
  • manuals/pkg-awesome-1.2.3.md
  • adrs/NN-auth-decision.md
  • research/202603-auth-pattern-investigation.md
  • stories/Task-1234-docs-links.md

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers