ドキュメント執筆にも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
グーグルの「Workspace」、ハイブリッド勤務に向けた新機能を追加
IT関連
2021-03-02 14:30
LegalForce、契約管理システム「LegalForceキャビネ」に担当者向け期限通知機能
IT関連
2022-12-01 10:14
HashiCorp、「Terraform Enterprise」 で2つのデプロイオプションを追加
IT関連
2023-09-23 10:11
SAP、世界最大のビジネスネットワーク「SAP Business Network」などを発表
IT関連
2021-06-04 06:53
Cloudflare WorkersがPythonをサポート、WebAssembly版Pythonランタイムの「Pyodide」を採用で
Cloudflare
2024-04-03 04:22
【コラム】ソーシャルメディアは科学と「根本的に対立」している可能性がある
IT関連
2022-02-12 23:29
Twitter、世界的指導者アカウントの取り扱いについてのアンケートを開始
アプリ・Web
2021-03-22 09:45
AIのバイアスはどうすれば解消できるか–レノボの取り組み
IT関連
2024-02-16 04:45
「ルンバ」などロボット掃除機の国内出荷台数が400万台を突破、2023年までに全国普及率10%目指す
ハードウェア
2021-02-18 14:35
飲食店の予約・顧客台帳サービス手がけるトレタと凸版印刷が提携、フードデリバリー領域新サービスを2021年末までに提供
フードテック
2021-05-20 10:35
ワークスアプリケーションズ、ERPと「Microsoft Copilot」の連携を開始
IT関連
2024-07-10 14:46
光洋ショップ‐プラスと富士通、生体認証を使った一般向けレジなし店舗を実証実験
IT関連
2021-01-16 08:13
サイバーセキュリティ、「隠さない文化」の醸成が重要
IT関連
2021-06-09 03:31
同種由来iPS細胞由来心筋細胞シートの開発・事業化を手がける大阪大学発スタートアップ「クオリプス」が20億円調達
バイオテック
2021-03-17 07:37