Communityライティング&編集github.com

strands-agents/harness-sdk (ドキュメントプランナー)

ドキュメントサイトのギャップを特定し、優先順位付きのバックログを生成します。ドキュメント改善スプリントの計画時、繰り返し発生する摩擦が報告された後、新しいSDK機能がドキュメントなしでリリースされた場合、または定期的な健全性評価に使用します。「ドキュメント作業の計画」「次に書くべきドキュメント」「バックログの優先順位付け」「ドキュメントの健全性チェック」といった指示にも対応します。

harness-sdk (ドキュメントプランナー) とは?

このスキルは、AIエージェントSDK(strands-agents/harness-sdk)のドキュメントサイトを分析し、不足しているコンテンツを特定して優先順位を付けるためのものです。開発者やテクニカルライターは、ドキュメント改善スプリントの計画時、コミュニティからのフィードバックが蓄積された後、または新しい機能がリリースされた際にこのスキルを呼び出すことで、客観的なデータに基づいたドキュメントバックログを作成できます。 プロセスは4段階で構成されています。まず、サイトのナビゲーション設定ファイルとコンテンツファイルをスキャンし、既存ドキュメントの完全なインベントリを作成します。次に、SDKの機能領域、Diataxis(チュートリアル、ハウツー、リファレンス、解説)の4タイプの網羅性、GitHubのドキュメント関連Issue、およびオプションで提供される競合製品のドキュメント状況と比較してギャップを特定します。その後、各ギャップを開発者への影響と実装コストに基づいてP0(今すぐやる)からP3(バックログ)まで優先順位付けします。最後に、優先順位付きタスク一覧、カバレッジマトリックス、およびコミュニティシグナルから得られたインサイトを含むMarkdown形式のバックログを出力します。 このスキルは、Astroベースのドキュメントサイトを前提としており、SDKのソースコードやGitHub CLIへのアクセスがある環境で最も効果的に機能します。ドキュメントを実際に執筆する機能は含まれていないため、ギャップの特定と優先順位付けに特化しています。

対応✓Claude Code✓Codex CLI~Cursor
npx skills add https://github.com/strands-agents/harness-sdk/tree/HEAD/.agents/skills/docs-planner

Installed? Explore more ライティング&編集 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

ドキュメントプランナー

ドキュメントサイトのギャップを特定し、優先順位付きのバックログを生成します。

入力

  • スコープ: 評価する領域 — 全ドキュメント、特定のセクション、または機能領域。デフォルト: すべて。
  • シグナル(任意): GitHub Issue、コミュニティの質問、サポートスレッド。
  • 競合コンテキスト(任意): 競合他社がドキュメント化しているが、自社では対応していない内容。

プロセス

ステップ1: 現在のドキュメントを棚卸し

site/src/config/navigation.yml を読み取り、完全なナビゲーションツリーを取得します — これはAstroサイトの信頼できるナビゲーションソースであり、site/astro.config.mjs から site/src/sidebar.ts を介して読み込まれます。site/src/content/docs/**/*.{md,mdx} をグロブし、すべてのコンテンツファイルを取得します。各ファイルをコンテンツタイプ(チュートリアル、ハウツー、リファレンス、解説、混在)とカバレッジ領域(クイックスタート、ツール、エージェント、マルチエージェント、デプロイなど)に分類します。

ステップ2: ギャップを特定

棚卸し結果を以下と比較します:

  • SDKの表面積: すべての主要機能がドキュメント化されていますか?ドキュメントページがない機能はギャップです。
  • Diataxisの完全性: 各機能領域について、4つのタイプすべてにドキュメントが存在しますか?リファレンスのみでチュートリアルがない機能はギャップです。
  • コミュニティシグナル: GitHub CLIが利用可能な場合、strands-agents/harness-sdk リポジトリからラベル「documentation」が付いたオープンIssueを取得します。質問を既存ドキュメント(不明瞭/見つけにくい)または欠落ドキュメント(コンテンツギャップ)にマッピングします。
  • 競合比較(提供された場合): LangChain、CrewAI、Anthropic、OpenAIが同等の機能についてドキュメント化しているが、自社では対応していない内容は何ですか?

ステップ3: 優先順位付け

各ギャップを開発者への影響と工数でスコアリングします:

  • P0(今すぐやる): 影響大、工数は問わない。クイックスタート、はじめに、コアコンセプト。
  • P1(すぐやる): 影響中、工数小。一般的なタスクの不足しているハウツーガイド。
  • P2(計画する): 影響中、工数大。新しいチュートリアル、アーキテクチャ解説。
  • P3(バックログ): 影響小。ニッチなシナリオ、エッジケースのドキュメント。

ステップ4: バックログを生成

Markdown形式で出力します:

## ドキュメントバックログ: [スコープ]

**生成日:** [日付]
**棚卸しページ数:** [数]
**特定されたギャップ数:** [数]

### P0: 今すぐやる
- [ ] [タスク] — [コンテンツタイプ] — [対象ページ] — [理由]

### P1: すぐやる
- [ ] [タスク] — [コンテンツタイプ] — [対象ページ] — [理由]

### P2: 計画する
- [ ] [タスク] — [コンテンツタイプ] — [対象ページ] — [理由]

### P3: バックログ
- [ ] [タスク] — [コンテンツタイプ] — [対象ページ] — [理由]

### カバレッジマトリックス

| 機能領域 | チュートリアル | ハウツー | リファレンス | 解説 |
|---|---|---|---|---|
| エージェント基礎 | Y | ~ | Y | N |
| カスタムツール | Y | Y | Y | N |
| マルチエージェント | ~ | N | Y | ~ |

### シグナル駆動のインサイト
- [コミュニティシグナルから特定のドキュメントギャップにマッピングされたテーマ]

このスキルが行わないこと

  • ドキュメントを書きません(その場合は docs-writer を使用してください)
  • 外部シグナルパイプラインを必要としません(ローカルインベントリのみで動作します)
  • 外部ツールにタスクを自動生成しません

関連スキル