Openclaw向けTechwrite: 高度なテクニカルライティングワークフロー

Techwriteは、複雑な技術概念を、開発者やステークホルダー向けの実用的で高精度な文章に変換するプロフェッショナルグレードのドキュメントエンジンです。

mike47512
v1.0.0
Mar 28, 2026
0
780
0

インストール&ダウンロード

1. ClawHub CLI

レジストリから直接スキルをインストールする最速の方法です。

npx clawhub@latest install techwrite

2. 手動インストール

スキルフォルダを以下のいずれかの場所にコピーしてください

グローバル
~/.openclaw/skills/
ワークスペース
<project>/skills/

優先順位:ワークスペース > ローカル > バンドル

3. プロンプトのインストール

このプロンプトをOpenClawにコピーするだけで、自動的にインストールされます。

Clawhubを使って techwrite をインストールして。Clawhubがインストールされていない場合は、先にインストールしてください(npm i -g clawhub)。

ダウンロードをご希望ですか?

ZIPアーカイブで生のスキルファイルを取得します。

Techwrite: 高度なテクニカルライティングワークフロー とは?

Techwriteは、AIエージェントが優れたテクニカルドキュメントを作成するために設計された専門的なワークフローです。単なる文字数から、明快さ、正確さ、適切な深さへと焦点を移します。この Openclaw Skills アセットを活用することで、開発者は、内部RFCs、公開APIリファレンス、または複雑な移行ガイドをドラフトする際に、ドキュメントがスキャン可能で、誠実であり、特定の読者ペルソナに合わせて調整されていることを保証できます。

このスキルは、曖昧な代名詞や隠れた前提といったドキュメント作成によくある落とし穴を防ぐために、厳格な6段階のライフサイクルを強制します。「片付けるべき仕事(job-to-be-done)」を優先し、すべてのコンテンツが、読者が混乱することなく自信を持って行動や決定ができる具体的な成功の結果に結びつくようにします。

Techwrite: 高度なテクニカルライティングワークフロー のユースケース

  • 新機能のための包括的なAPIリファレンスと統合ガイドのドラフト作成。
  • RFCs (Request for Comments) や ADRs (Architecture Decision Records) などの重要なエンジニアリングドキュメントの作成。
  • スキャン可能な運用手順書(runbooks)、事後分析(postmortems)、開発者向けオンボーディングドキュメントの作成。
  • 既存の技術ページを洗練させ、明快さを向上させ、文章内の技術的負債を取り除く。
  • サポートチケットを削減するためのトラブルシューティングテーブルやエッジケースドキュメントの生成。

Techwrite: 高度なテクニカルライティングワークフロー の仕組み

  1. オーディエンスと目標の定義: 内容を絞り込むために、単一の主要な読者ペルソナと特定の「片付けるべき仕事」を特定することから始めます。
  2. アウトラインとスコープ設定: BLUF (Bottom Line Up Front) の原則を使用してドキュメントを構成し、セクションを読者のメンタルモデルにマッピングします。
  3. コアコンテンツのドラフト作成: 曖昧な形容詞を避け、最初の使用時に技術用語を定義しながら、正確で能動態の文章を生成します。
  4. 例とエッジケース: ユーザーの信頼を築くために、最小限の完全なコードスニペットと現実的な失敗シナリオを統合します。
  5. 明快さのレビュー: 曖昧な代名詞を取り除き、すべての図図やリンクが機能しアクセス可能であることを確認するために、外科的な編集を行います。
  6. メンテナンス計画: 時間の経過によるドキュメントの陳腐化を防ぐために、所有権とレビューサイクルを確立します。

Techwrite: 高度なテクニカルライティングワークフロー のセットアップ

Techwriteを環境に統合するには、Openclaw Skills ランナーがインストールされていることを確認し、エージェントのライブラリに techwrite の定義を追加します。

# ローカルリポジトリに techwrite スキルを追加
openclaw skills add techwrite

# AI IDE または CLI 内でワークフローをトリガー
/skill techwrite "新しい認証モジュールのAPIガイドをドラフトして"

Techwrite: 高度なテクニカルライティングワークフロー のデータスキーマとタクソノミー

Techwriteは、大規模なドキュメントセット全体で一貫性を維持するために、ドキュメントデータを構造化されたタクソノミーに整理します:

属性 説明 形式
成功の文章 読者にとっての明示的な成果 String
ペルソナ ターゲット読者 (例:SRE, 新入社員) Taxonomy Key
BLUF 結論を先に (Bottom Line Up Front) サマリー Markdown Block
手順のステップ 番号付きのアクションシーケンス Ordered List
メタデータ バージョニング、所有者、最終レビュー日 YAML Frontmatter

Techwrite: 高度なテクニカルライティングワークフロー の高度な機能

  • 多段階のイテレーションサポート:ラフなアウトラインから、洗練されたリリース可能な文章へとシームレスに移行します。
  • テンプレート統合:組織のスタイルガイドや特定のドキュメントテンプレートを取り込み、それに従う機能。
  • 外科的編集:原著者の声を維持しながら、既存のドラフトを洗練させます。
  • アクセシビリティのガードレール:図の alt-text や安定した URL 構造の自動チェック。
  • 戦略的な非推奨化:進化するプラットフォームのためのリダイレクトやページ履歴の処理に関するガイダンス。

SKILL.md


ローディング

関連するOpenclawのスキル

METADATA

Github Stars: 0
forks: 0

特徴*