フリースタイル社員の部屋

フリースタイルのスタッフがリレー形式で綴るブログ。投稿をお楽しみに!

AsciiDocを使ってみた

2022年06月17日 | お仕事
みなさん、AsciiDocをご存じでしょうか。
私は今参画しているプロジェクトで初めて知りました。

ググると結構ヒットします。
ググったサイトからいくつか要点をまとめました。

出典:Qiita AsciiDoc入門
AsciiDocの利点
・Markdownと同等の可読性で、表現力が高い。
・記法を拡張する方法が言語仕様に定められている。
AsciiDocの欠点
・Markdownに比べ普及していない。

出典:ASCII.JP エンジニアのドキュメント作成に適した「AsciiDoc」とは?
AsciiDocとは
・AsciiDocは軽量マークアップ言語の一つで可読文書記述形式です。
・出力もHTML, PDF, ePubなどが行えるため個人での出版活動から開発環境でのナレッジの共有まで様々な用途で利用する事が可能です。

などなど、他にも具体的なリファレンスなどもあります。

クラス図などUMLを描くこともできるようです。
出典:かんがるーさんの日記 Asciidoctor Diagram を使用して AsciiDoc 形式のドキュメントに PlantUML の図を埋め込む

実際に設計書を書いているのですが、非常に軽量でサクサク開くことができます。
Excelのように重いとか、意図せず編集中に落ちるとかはないようです。
HTMLのタグを用いたりすることもできます。
AsciiDocの言語仕様に従い章節を付与することもできるし、表や図も埋め込めます。
表番号や図番も自動で付与することができます。
やり方次第ですが、表中に連番をふったり、図に①②③などの丸付き番号を付与したりもできます。
ただ、この言語仕様を覚えなきゃいけないので最初は作業スピードが落ちます。
「Excelで書いた方が早いな」と思ってしまいます。

でも、使いこなせるようになればExcelが過去の遺物のようになるかもしれませんね。
自分的には表現方法など探りながら「こんことやあんなことができるんだ」と感心しています。
みなさんもこの機会にぜひ触れてみてください。

今日はここまで!


この記事についてブログを書く
  • Twitterでシェアする
  • Facebookでシェアする
  • はてなブックマークに追加する
  • LINEでシェアする
goo blogユーザーが出品しています
他の出品作品をマルシェルで見る
« JavaScriptの歴史 | トップ | 新人研修の所感 »
最新の画像もっと見る

お仕事」カテゴリの最新記事