Allはじめに·

Harness Wiki 記事ガイドライン

Shudesuのプロフィール画像

Shudesu

Author

Harness Wiki 記事ガイドライン

このWikiの記事は2つの顔を持ちます:

  1. 人間が読んで「やりたい!」と思える
  2. Claude Code にコピペしたらそのまま動く

タイトルのルール

やること

  • 「何ができるか」を書く(機能名じゃなく、結果を書く)
  • 動詞で始める or 疑問形にする
  • 読んだ人が「それ欲しい」と思うタイトルにする

やらないこと

  • バージョン番号をタイトルに入れない
  • 英語の技術用語だけのタイトルにしない
  • 内部的な実装名を出さない

❌ やめよう✅ こうしよう
LINE Harness v0.5.0 — スタッフ管理機能チームで運用する — スタッフごとに権限を分ける
Flex Message altText & テンプレートプッシュ通知のプレビューを見やすくする
API コスト最適化X API の料金を90%カットする方法
ゲート冪等性修正DMが何回も届くバグを直す
create-x-harness CLI1コマンドでX Harnessをデプロイする

記事の構成

1. 最初の3行で「何が嬉しいか」を伝える

# チームで運用する — スタッフごとに権限を分ける

複数人でLINE Harnessを使うとき、誰が何をできるか制御できます。
アルバイトに配信権限だけ渡して、顧客データは見せない、みたいな使い方。

2. コピペで動くコードブロック

  • コマンドは そのままターミナルに貼れる形 で書く
  • 「YOUR_API_KEY」等のプレースホルダーは最小限にする
  • Claude Code に渡すことを前提に、コンテキストを含める
## やり方

以下をClaude Codeに貼ってください:

「LINE Harnessでスタッフを追加して。名前は田中、ロールはstaff。」

またはターミナルで:

\`\`\`bash
curl -X POST https://your-worker.workers.dev/api/staff \\
  -H "Authorization: Bearer YOUR_API_KEY" \\
  -H "Content-Type: application/json" \\
  -d '{"name": "田中", "role": "staff"}'
\`\`\`

3. 「なぜ嬉しいか」を具体的に書く

抽象的な機能説明ではなく、使用シーンを書く:

## こんなときに使える

- 美容院: 受付スタッフにはメッセージ送信だけ許可、オーナーだけ配信設定を変更
- ECショップ: カスタマーサポート担当にタグ付けだけ許可
- スクール: 講師にはチャット返信だけ、事務局に配信権限

文体のルール

ルール理由
敬語は使わない(だ・である調)技術ドキュメントは簡潔に
1文は60文字以内スマホで読みやすく
専門用語は初出時に一言説明導入代理層でもわかるように
英語は必要最小限日本語で言えることは日本語で
スクショは 📸 スクショ反映中: で仮置き後からでも記事を公開できるように

カテゴリの使い分け

カテゴリいつ使うタイトル例
はじめに初めて触る人向け「LINE Harnessを5分でセットアップする」
活用事例こんな使い方ができる「美容院の予約リマインダーを自動化する」
プラグイン外部連携の方法「HotPepperの予約をLINEに通知する」
Tips & 裏技知ってると便利なこと「タグを使って顧客をセグメント分けするコツ」
変更履歴新機能・バグ修正「プッシュ通知のプレビューが見やすくなった」

Copy this page ボタン

各記事の右上に「Copy this page」ボタンがある。 これはClaude Code等のLLMにページ全体をMarkdownで渡すためのもの。

だからこそ、記事の中身は コピペしてAIに渡したらそのまま実行できる クオリティであるべき。

#guidelines#writing#community
この記事が役に立ったら投票してください

コメント (0)

コメントするにはログインしてください。