いつもBacklogをご利用いただきありがとうございます。
このたび、Backlogのドキュメント機能をより便利にご利用いただくため、テキストファイルを簡単に取り込める「インポート機能」と、外部ツールやプログラムからより柔軟に操作できる「ドキュメント追加・削除API」をリリースいたしました。
目次
開発の背景
Backlogのドキュメント機能は、簡単かつ直感的な文書作成を目指しています。
これまでユーザーの皆さまからは、「PC上のテキストファイルからドキュメントを作りたい」「ほかのツールで作成したMarkdownファイルを、手動でコピーアンドペーストして整形するのが手間だ」といったお声をいただいておりました。
こうしたニーズにお応えし、情報の集約をよりスムーズにするため、Markdownファイルをアップロードするだけでドキュメントを一括作成できる「インポート機能」をリリースしました。
あわせて、「外部システムのレポートを自動でドキュメントにアップロードしたい」「不要になったドキュメントをスクリプトで一括削除したい」というご要望に基づき、外部ツールやプログラムから直接操作を可能にするAPIエンドポイントも提供開始いたしました。
インポート機能について
本機能では、テキストファイルをドラッグアンドドロップ、またはファイル選択するだけで、 Backlogのドキュメントを一括で作成できます。
Wikiからの移行機能と同様に、インポートされたデータはリッチテキスト形式のドキュメントに変換されます。インポート機能を活用することで、ほかのツールに蓄積されたナレッジや情報資産をスムーズに移行し、Backlogへ情報を集約できます。
なお、インポートで作成されたドキュメントは、サイドバー内では現在開いているドキュメントの1つ下の位置に追加されます。
インポート機能の使い方
- ドキュメント機能の編集画面右上にある三点リーダー(…)をクリックし、メニュー内の「インポート」をクリックします
- ファイルをドラッグアンドドロップ、または「ファイルを選択」ボタンをクリックしてインポートしたいファイルをアップロードします
ファイルをアップロードすると、インポートが自動で開始されます。
インポートに成功すると、「n個のファイルをインポートしました。」のダイアログが画面右下に表示され、インポートしたファイルがドキュメントとして追加されます。
注意事項
- インポート可能なファイル形式は .md, .markdown, .txt です。
- プレーンテキストのインポート自体は可能ですが、見出しやコードブロックなどの装飾を反映させるには、Markdown記法で記述されたファイルである必要があります。なお、Backlog記法には対応しておりません。
- Data URI スキームなど、一部の記法についてはサポートしない場合がございます。あらかじめご了承ください。
- 詳しくはドキュメントの基本的な使い方｜Backlog ヘルプセンターをご確認ください。
ドキュメント追加・削除APIについて
外部ツールやプログラムから、Backlogのドキュメントをより柔軟に追加・削除できるようにするためのAPIエンドポイントをリリースしました。
これまでは画面上からの操作が中心でしたが、ユーザーの皆さまより「外部システムで生成したレポートを自動でドキュメントにアップロードしたい」「不要になったドキュメントをスクリプトで一括削除して整理したい」といった、自動化や効率化に関するご要望を多くいただいておりました。
そこで今回、ドキュメントの運用管理をより効率化できるよう、プログラムから直接ドキュメントを操作できるAPIエンドポイントをリリースしました。
これまで、WikiのAPI連携がネックとなりWikiからドキュメントへの移行を見送られていたお客さまも、このAPIの活用でスムーズに移行を行っていただけます。
詳しいパラメータやレスポンスの形式については、Backlog API デベロッパーサイトをご確認ください。
おわりに
今回は、Backlogのドキュメント機能をより便利に使っていただける「インポート機能」「ドキュメント追加・削除API」についてお知らせしました。
これからも使いやすさの向上に取り組んでまいりますので、ぜひドキュメント機能をご活用いただき、チームのコラボレーションにお役立てください。
ご利用いただく中でお気づきの点がありましたら、ぜひお問い合わせください。
