docs-planner

GitHub

识别文档缺口并生成优先级待办列表。用于规划文档冲刺、分析摩擦信号或评估新特性文档缺失情况,通过对比SDK功能和社区反馈确定高优任务。

.agents/skills/docs-planner/SKILL.md strands-agents/harness-sdk

触发场景

plan docs work what docs need writing prioritize the backlog docs health check what should we document next

安装

npx skills add strands-agents/harness-sdk --skill docs-planner -g -y
更多选项

非标准路径

npx skills add https://github.com/strands-agents/harness-sdk/tree/main/.agents/skills/docs-planner -g -y

不安装直接使用

npx skills use strands-agents/harness-sdk@docs-planner

指定 Agent (Claude Code)

npx skills add strands-agents/harness-sdk --skill docs-planner -a claude-code -g -y

安装 repo 全部 skill

npx skills add strands-agents/harness-sdk --all -g -y

预览 repo 内 skill

npx skills add strands-agents/harness-sdk --list

SKILL.md

Frontmatter
{
    "name": "docs-planner",
    "description": "Identify documentation gaps and prioritize the docs backlog. Use when planning a docs improvement sprint, after signals surface repeated friction, when new SDK features ship without docs, or for periodic health assessment. Also triggers on \"plan docs work\", \"what docs need writing\", \"prioritize the backlog\", \"docs health check\", \"what should we document next\"."
}

Documentation Planner

Identify gaps in the docs site and produce a prioritized backlog.

Inputs

  • Scope: Area to assess — all docs, a specific section, or a feature area. Default: all.
  • Signals (optional): GitHub issues, community questions, support threads.
  • Competitive context (optional): What competitors document that we don't.

Process

Step 1: Inventory current docs

Read site/src/config/navigation.yml for the full navigation tree — this is the authoritative navigation source for the Astro site, loaded by site/astro.config.mjs via site/src/sidebar.ts. Glob site/src/content/docs/**/*.{md,mdx} for all content files. Classify each by content type (tutorial, how-to, reference, explanation, mixed) and coverage area (quickstart, tools, agents, multi-agent, deployment, etc.).

Step 2: Identify gaps

Compare the inventory against:

  • SDK surface area: Are all major features documented? Features without docs pages are gaps.
  • Diataxis completeness: For each feature area, does documentation exist across all four types? A feature with reference but no tutorial has a gap.
  • Community signals: If GitHub CLI is available, pull open issues labeled "documentation" from strands-agents/harness-sdk. Map questions to existing docs (unclear/hard to find) or missing docs (content gap).
  • Competitive comparison (if provided): What do LangChain, CrewAI, Anthropic, and OpenAI document about equivalent features that we don't?

Step 3: Prioritize

Score each gap on developer impact and effort:

  • P0 (do now): High impact, any effort. Quickstart, getting-started, core concepts.
  • P1 (do soon): Medium impact, low effort. Missing how-to guides for common tasks.
  • P2 (plan for): Medium impact, high effort. New tutorials, architectural explanations.
  • P3 (backlog): Low impact. Niche scenarios, edge case documentation.

Step 4: Produce the backlog

Output as markdown:

## Docs Backlog: [Scope]

**Generated:** [date]
**Pages inventoried:** [count]
**Gaps identified:** [count]

### P0: Do Now
- [ ] [Task] — [content type] — [target page] — [reason]

### P1: Do Soon
- [ ] [Task] — [content type] — [target page] — [reason]

### P2: Plan For
- [ ] [Task] — [content type] — [target page] — [reason]

### P3: Backlog
- [ ] [Task] — [content type] — [target page] — [reason]

### Coverage Matrix

| Feature Area | Tutorial | How-To | Reference | Explanation |
|---|---|---|---|---|
| Agent basics | Y | ~ | Y | N |
| Custom tools | Y | Y | Y | N |
| Multi-agent  | ~ | N | Y | ~ |

### Signal-Driven Insights
- [Theme from community signals mapped to specific doc gaps]

What This Skill Does NOT Do

  • Does not write docs (use docs-writer for that)
  • Does not require external signal pipelines (works with local inventory alone)
  • Does not auto-create tasks in external tools

版本历史

  • 2b6af5a 当前 2026-08-20 16:58

同 Skill 集合

.agents/skills/docs-audit/SKILL.md
.agents/skills/docs-diagrams/SKILL.md
.agents/skills/docs-reviewer/SKILL.md
.agents/skills/docs-writer/SKILL.md
.agents/skills/pr-create/SKILL.md
.agents/skills/pr-feedback/SKILL.md
.agents/skills/pr-writer/SKILL.md
.agents/skills/pre-push/SKILL.md
.agents/skills/strands/SKILL.md
.agents/skills/strands/skills/add-mcp-server/SKILL.md
.agents/skills/strands/skills/add-tool/SKILL.md
.agents/skills/strands/skills/build-with-strands/SKILL.md
.agents/skills/strands/skills/port-from-langgraph/SKILL.md
.agents/skills/strands/skills/scaffold-agent/SKILL.md
.agents/skills/strands-review/SKILL.md

元信息

文件数
0
版本
1adcaf9
Hash
e1c3a19e
收录时间
2026-08-20 16:58

首页 - Wiki
Copyright © 2011-2026 iteam. Current version is 2.155.2. UTC+08:00, 2026-11-04 10:59
浙ICP备14020137号-1