ドキュメント執筆にもGit、ビルド、テストで再利用性や整合性を実現する「Writerside」、JetBrainsがプレビューリリース

今回は「ドキュメント執筆にもGit、ビルド、テストで再利用性や整合性を実現する「Writerside」、JetBrainsがプレビューリリース」についてご紹介します。

関連ワード (作成、単一、表現可能等) についても参考にしながら、ぜひ本記事について議論していってくださいね。

本記事は、Publickey様で掲載されている内容を参考にしておりますので、より詳しく内容を知りたい方は、ページ下の元記事リンクより参照ください。


Kotlinなどの開発元として知られるJetBrainsは、テクニカルドキュメントのための一連のツールを統合したドキュメントオーサリングツール「Writerside」のプレビューリリースを発表しました。

fig

ソフトウェア開発においては、テキストで記述されたソースコードをGitでバージョン管理し、ビルドによって複数のソースコードを1つのアプリケーションへとまとめ上げ、コンパイルし、テストをして本番環境へのデプロイによりアプリケーションを公開します。

そしてこのプロセス全体を、さまざまな機能を備えたツールチェンを用いて自動化することで、ソフトウェア開発の効率を高めています。

一方で、例えばアプリケーションのチュートリアル、SDKやAPIのリファレンスドキュメントなどのドキュメントの制作過程においては、複数のファイルをフォルダにまとめ、手作業で目次のページとリンクさせることや、ソースコードのサンプルの記述や、警告のための赤いアイコンなど、リッチな表現の実装のためにCSSやJavaScriptなどを手作業でドキュメントファイルの中に書き込んで実現してしまうケースも多いでしょう。

この方法では、目次が変わるたびに慎重な変更作業が必要ですし、見栄えを改善しようとしても1つ1つの該当ページをマニュアルで書き換えていくほかありません。

こうした手作業の多いドキュメントの作成を、ソフトウェア開発者が用いているのと同じようにツールチェーンによる自動化によって効率を高め、開発者とのコミュニケーションを容易にする目的を持っているのが、今回プレビューリリースとなった「Writerside」です。

Markdownに対応、MermaidやLaTexの記述も可能

Writersideでは、ファイルだけでなくGitによるコンテンツの管理が可能。コンテンツの再利用も容易になっています。

ドキュメントはMarkdownもしくはJetBrainsの独自セマンティックによるXML形式での記述が可能です。また、Mermaidによるダイアグラムの記述、LaTexによる数式の記述も可能になっています。

テンプレート機能によって、リファレンスマニュアルなどでよく見られる「ワーニング」の赤い文字や「Note」などの注釈のレイアウトなどが、簡単なマークアップで表現可能になり、あとからまとめて見栄えなどを変更することも可能です。

ビルドを実行しなくとも、Writerside上で単一のページをライブプレビューしたり、Webブラウザーでサイト全体を開いて参照できたりできます。

ライブプレビューとビルドではテストが行われ、マークアップの属性やセマンティックなどの誤り、あるいは組織毎に設定された執筆ルールなどから外れた要素があれば検出できます。

実際にJetBrainsのIntelliJ IDEAドキュメントやKotlinヘルプなどは、Writesideで作成されているとのことです。

COMMENTS


Recommended

TITLE
CATEGORY
DATE
日本企業の脆弱性管理に苦言を呈するテナブル日本代表の危機感とは
IT関連
2022-02-05 18:38
中国で人気の虹彩写真–安易なSNS投稿に注意呼びかけも
IT関連
2025-01-29 11:50
HPEのネリCEO、「AIにはハイブリッドクラウドが必要」–NVIDIAと新ソリューション発表
IT関連
2024-06-21 13:06
NTTSportictがアマチュアスポーツの自動撮影・自動配信が可能な「Stadium Tube Lite」を発表
人工知能・AI
2021-06-19 05:14
導入したAI-OCRの効果を得るための工夫とは?–ファンケルの事例
IT関連
2021-03-04 21:54
デロイト、レッドハット、HPE、スピード重視のデジタル変革支援サービス
IT関連
2021-01-25 05:21
教育現場で広がる「Microsoft 365 Education」の活用事例–Microsoft Education EXPO 2023
IT関連
2023-07-09 07:25
SpaceXの巨大宇宙船「Starship」、“3度目の正直”で高高度からの垂直着陸に成功……と思いきや数分後に爆発
企業・業界動向
2021-03-05 18:57
メニーコアに最適化した国産の高性能RDB「劔(Tsurugi)」、ソースコードの公開を開始
RDB
2023-10-06 08:53
“説明可能なAI”の教科書、日本語訳を公開 「AIに何ができ、何ができないか」理解の手引きに
ロボット・AI
2021-05-19 09:42
三井不動産、全従業員向けに自社特化型の生成AIツールを導入
IT関連
2023-10-12 02:58
インテントAIが製薬にもたらすインパクトと未来
IT関連
2025-03-20 13:59
AI搭載のアプリ開発に都立中高生が挑戦–4日間の努力が強い自信に
IT関連
2024-08-22 12:23
生成AIが自律的に顧客と会話し、カスタマサービスを提供する「Einstein Service Agent」。Salesforceが発表
Salesforce
2024-07-19 07:12