ドキュメント執筆にも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
マイクロソフト、「Android」向け軽量アプリ「Outlook Lite」を広く提供へ
IT関連
2022-07-05 13:34
勢いづく米Tesla “走るスマホ”で黒字転換 先行きに不安も 
IT関連
2021-02-05 12:34
ムーンショット型研究開発制度として本格始動、量子コンピューターへの期待
IT関連
2021-01-29 20:43
マイクロソフト、Arm版Windowsのアプリ開発を支援する小型PC「Project Volterra」
IT関連
2022-05-27 17:32
共働き世帯向けに作り置き用家庭料理を週に1度配達するサービス「つくりおき.jp」のAntwayが15億円調達
フードテック
2021-08-11 15:31
マイクロソフトと富士通、5年間の戦略的なグローバル協業を発表
IT関連
2023-05-30 17:26
ABC Cooking Studio、人事労務クラウドでデータ連携を効率化
IT関連
2024-11-22 22:31
外部予約サイトの中継サーバに不正アクセス、宿泊者の情報流出 ホテルサンルート台北
セキュリティ
2021-04-13 07:19
東芝デジタルソリューションズ、企業向けブロックチェーンを提供開始
IT関連
2022-05-12 09:54
ウィズセキュア、日本法人のカントリーマネージャーに藤岡健氏
IT関連
2023-11-03 04:28
Okta、開発者向けの新たな無料プラン–最大1.5万人の月間ユーザーに対応
IT関連
2021-04-07 06:24
絶滅危惧種「フタ止めシール」の歴史を振り返る
くらテク
2021-06-04 04:37
中学女子アスリートの水着画像を無断転載 サイト運営の男逮捕
IT関連
2021-06-24 12:28
GMは2030年までにCruiseの自動運転技術を用いた個人向け自動運転車を販売する意向
モビリティ
2021-05-16 22:32