リリースノートを自動作成
リリースノート作成は、変更点の箇条書きから公開用のリリースノートを組み立てるツールです。開発者向けの技術的な記述を、利用者に伝わる分かりやすい文章に言い換え、公開前の整理にかかる時間を減らします。
オンラインで実行
アカウントでログインし、当社のサーバー上で実行します。無料ツールはブラウザ内で動作しますが、これは上記の料金がKIT残高から差し引かれます。
入力する内容
コミットメッセージやチケットの一覧、修正点のメモを箇条書きで渡します。新機能・改善・不具合修正のように分類を指定すると、その区分で整理して出力します。
読者に応じた言い換え
開発者向けの技術的な表現を、一般の利用者にも伝わる文章に言い換えます。社内向けと外部公開向けで、残す情報量を変えることもできます。
料金
料金は1リクエストあたり$0.003(米ドル)、作成するリリースノート1件ごとに$0.0135です。バージョンごとに分けて作成する場合は、件数分が加算されます。
活用例
月次アップデートの公開
合同会社みどりデザインの開発チームは、月1回のアップデートのたびに、変更点のメモをこのツールでリリースノートに整えています。
社内向けと社外向けの使い分け
田中大輔は同じ変更点から、社内共有用の詳しいメモと、顧客向けの簡潔なお知らせを、このツールで作り分けています。
複数プロダクトの更新履歴
山本翔太は担当する複数のプロダクトごとに、更新履歴のページに載せる文章をこのツールでまとめて作成しています。
よくある質問
技術的な変更点をそのまま貼り付けても大丈夫ですか
問題ありません。コミットメッセージのような専門的な書き方のまま渡していただければ、読みやすい文章に言い換えます。
入力した変更点の内容は保存されますか
渡していただいた変更点のメモは、リリースノートに変換したあと、こちらのサーバーに残ることはありません。
変更点の件数に上限はありますか
1回のリクエストで処理できる件数には上限があります。件数が多い場合は、複数回に分けて渡すことをおすすめします。
日本語のサポートはありますか
申し訳ありませんが、日本語でのサポートは行っておりません。サポートは英語またはスペイン語で、担当者が直接対応します。ツール自体は日本語で問題なくご利用いただけます。
料金はどう支払いますか
PayPalでの直接支払いです。1リクエスト$0.003に加え、リリースノート1件ごとに$0.0135がかかります。
社内文書としての利用もできますか
できます。外部公開用だけでなく、社内共有用の更新メモの作成にもご利用いただけます。
開発者向け — APIアクセス
このページの機能はすべてAPIからも利用できます。自社システムに組み込みたいチーム向けのセクションです。それ以外の方は上のツールをそのままお使いください。
エンドポイント
Bearerトークンで認証し、POST1回でタスクをキューに登録します。結果はWebhookまたは署名付きリンクで受け取れます。
お使いのスタックから呼び出す
curl -X POST https://api.kit.forhosting.com/text/changelog \
-H "Authorization: Bearer $KIT_KEY" \
-H "Content-Type: application/json" \
-d '{"input":"…"}'const res = await fetch("https://api.kit.forhosting.com/text/changelog", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.KIT_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"input": "…"
})
});
const { task_id } = await res.json();import os, requests
res = requests.post(
"https://api.kit.forhosting.com/text/changelog",
headers={"Authorization": f"Bearer {os.environ['KIT_KEY']}"},
json={
"input": "…"
},
)
task_id = res.json()["task_id"]<?php
$res = file_get_contents("https://api.kit.forhosting.com/text/changelog", false, stream_context_create([
"http" => [
"method" => "POST",
"header" => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
"content" => '{"input":"…"}',
],
]));
$task = json_decode($res, true);body := bytes.NewBufferString(`{"input":"…"}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/text/changelog", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)リクエスト例
{
"input": "…"
}レスポンス例
{
"task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
"type": "text.changelog",
"status": "queued",
"_links": {
"result": "/tasks/tsk_…/result"
}
}非同期APIです。task_idは即時に返ります。ポーリングは1秒あたり1リクエストまでです。
料金
単価はすべて公開しています。トークン換算や独自クレジットはありません。失敗したタスクは課金されません。
制限
max_tokens | 20000 |
エラー
| HTTP | コード | 意味 |
|---|---|---|
401 | unauthorized | APIキーが無効か、指定されていません。Authorizationヘッダーを確認してください。 |
402 | insufficient_balance | 残高が不足しています。チャージ後に再度お試しください。 |
404 | unknown_type | 指定されたタスクタイプは存在しません。タイプ名を確認してください。 |
429 | rate_limited | リクエストが多すぎます。しばらく待ってから再度お試しください。 |
422 | task_failed | タスクの処理に失敗しました。このタスクは課金されません。 |