ドキュメント執筆にも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-10-15 13:35
次期iPad miniのデザインはiPad Pro風? 試作段階へ
IT関連
2021-05-07 07:13
「Cloudera Data Platform」が「Google Cloud」上で利用可能に
IT関連
2021-04-02 07:58
リース会社の枠を超えた価値提供–三菱HCキャピタルが考える「アセット+α」のDX戦略
IT関連
2024-01-10 16:41
Macでハイレゾロスレス再生環境を設定する方法 USB接続DACをつなげて、それからやるべきこと
IT関連
2021-05-25 15:40
マイクロソフト、脅威アクターの命名規則を変更–天気にちなみ分かりやすく
IT関連
2023-04-21 22:07
TIS、大量の紙文書をデジタル化するサービスを提供–検索を容易にし資産文書を有効活用
IT関連
2023-05-27 15:41
多くのIT部門でアジャイルアプローチが成功しない理由
IT関連
2024-02-01 10:15
携帯電話の“オンライン解約”解禁へ議論 ドコモと楽天は対応、KDDIとソフトバンクは慎重な姿勢
企業・業界動向
2021-04-27 22:28
WebAssembly化したPostgreSQLをWebブラウザ上で実際に動かして学ぶ「Postgres playground」をCrunchy Dataが公開
PostgreSQL
2022-08-19 22:28
WebAssemblyでサーバレスアプリケーションを開発するフレームワーク「Spin」がバージョン1.0に到達
WebAssembly
2023-03-30 07:42
開始まで1年4カ月–インボイス制度対応で気を付けたい3つの落とし穴:freee解説
IT関連
2022-06-02 17:16
SPACへの資金殺到が続く中「市場はいつまで資金を吸収できるのか」との疑問の声高まる
VC / エンジェル
2021-02-27 03:10
マイクロソフト、「Windows」の隠し機能にアクセスできる社内ツールを誤って公開
IT関連
2023-08-05 11:01