AsciiDoc と PlantUML と mermaid.js で素敵なテキストベース仕様書ライフ
以前からテキストベースで仕様書(PDF)などを管理したいと思っていたのですが、ようやくその環境が整い、一度実際に運用してみてかなりいい感じだったので紹介したいと思います。 基本テキストは AsciiDoc で記述する UML は PlantUML で記述する フローチャートとかは必要に応じて mermaid.js も使う つまり基本テキストで表現・管理できるものはテキストで書く 成果物は PDF形式。目次(Table of Contents) はつける。 動作確認環境 macOS Sierra 10.12.3 ruby 2.3.1 Asciidoctor 1.5.5 Asciidoctor PDF 1.5.0.alpha.14 Asciidoctor Diagram 1.5.4 mermaid 7.0.0 AsciiDoc とは AsciiDoc Home Page 軽量マークアップ言語の
エクセルやパワーポイントのドキュメントを捨てて、超美麗なドキュメント作成をasciidoctorで実現しよう！ - Qiita
エクセルやパワーポイントのドキュメントを捨てて、超美麗なドキュメント作成をasciidoctorで実現しよう！asciidoctorasciidoctor-pdf 開発には付き物のドキュメント作成、現場ではワードやエクセル、パワーポイントを使うことが普通ですよね？ そんなドキュメント作成に革命を起こしそうなのがasciidoctorです。 Office製文書の悪い問題を簡単に解決してくれます。 Officeで技術文書を作成する時の問題点 成果物がバイナリなので Git などのバージョン管理ツールと相性が悪い 内容以外の修飾に掛かる時間が膨大すぎる、ワード以外では目次の作成、章番号の連番付け、印刷結果との違いの確認など 文章の内容を記述する時間より、体裁を整えるのに時間が掛かる Windows以外ではなかなか編集できない コードのハイライトなどできない コピーペーストがままならず同じパワポ同
asciidoctor-pdfで社内ドキュメントを書こう - Qiita
この投稿は Fujitsu Advent Calender 2016 の 12日目の記事です。 この記事に書かれた見識は個人のものであり、所属する会社・組織を代表するものではありません🐸。 12/12修正: asciidoctor-pdfインストールコマンドに誤りがありました。 サンプルのスタイルファイル名を confidential_style.yaml から public_style.ymlに変更し、機密区分表記をPublicにしました（不適当だったため）。 合わせてサンプルPDFドキュメントの画像を差し替えています。 その他タイポを修正しました。 背景・動機🐸 技術職にかぎらず、仕事をする上でドキュメントを書く機会はたくさんありますが、大なり小なり組織に所属している以上、好き勝手にオレオレフォーマットを作って、「これがオフィシャルです」・というのはなかなか難しく、組織の内で用意さ
Asciidoctor | A fast, open source text processor and publishing toolchain for converting AsciiDoc content to HTML5, DocBook, PDF, and other formats.
A fast text processor & publishing toolchain for converting AsciiDoc to HTML5, DocBook & more. = Hello, AsciiDoc! Doc Writer <doc@example.com> An introduction to http://asciidoc.org[AsciiDoc]. == First Section * item 1 * item 2 [source,ruby] puts "Hello, World!" Asciidoctor is a fast, open source, Ruby-based text processor for parsing AsciiDoc® into a document model and converting it to output for
脱Word、脱Markdown、asciidocでドキュメント作成する際のアレコレ - Qiita
asciidocとは asciidocはMarkdownなどのような軽量マークアップ言語の一つで、Webページなどをプレーンテキストで記述することができる(拡張子は.adoc) asciidocを使うようになった経緯 これまではWordで機能仕様書とか書いていたが、Wordは重い、変更場所が分からない、複数人同時に修正とか面倒で、いい加減Wordを使うのは止めたくなった なので軽量マークアップ言語にしよう、一番メジャー？なMarkdownにしたら、以下の制約とかでいくらなんでもイマイチ。。 表でセルの結合ができない 表のセル内で箇条書きができない 目次が作れない 文字に色がつけられない 上記に対応しようとすると、プラグインやらMarkdown亜種がいろいろ。。 そこで、Markdownより表現方法が豊富なasciidocを使用し、実際に使って、特徴・課題を挙げてみた。 asciidocto
AsciiDocによる継続的ドキュメント開発〜１．インストールと基本的な使い方 - dackdive's blog
はじめに ドキュメントを書くための言語としておそらく今一番ポピュラーなのは Markdown だと思いますが、 かっちりした仕様書やユーザーマニュアルなど、より本格的なドキュメント作成にはやや機能不足と感じることがあります。 私も以前、ドキュメントを Gitbook で作れないか検討したことがあったんですが 表を書くのがめんどくさかったり、図のキャプションなどに対応していなかったことから断念しました。 そこで、今回は Markdown よりも表現力の高い言語として知られる AsciiDoc を試してみます。 AsciiDoc は O'reilly でも採用されているほか、Pro Git や JavaScript Promise の本 などの非常に完成度の高い技術ドキュメントが AsciiDoc で書かれています。 （参考記事） ・テクニカルライティングの未来を先取り ー Asciidoc
AsciiDoc入門 - Qiita
AsciiDocとは AsciiDocはMarkdownなどのような軽量マークアップ言語の一つです。 利用例 Pro Git book - Github オライリーの書籍 Clojure Cookbook - Github Programming Scala Mastering Bitcoin - Github Open Government - Github O’Reilly Atlas Neo4j documentation - Github Git User's Manual なぜAsciiDocを使うのか 表現力と可読性 技術文書を書く場合HTMLは汎用性が高いが可読性が低い、一方Markdownは可読性が高いがテーブル記法がないなど表現力が乏しい。 AsciiDocは可読性が高く表現力もある程度高いので、技術文書等を書くには最適である。 表現力：HTML > AsciiDoc >
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
http://www.methods.co.nz/asciidoc/
[支える技術]エクセルやパワーポイントのドキュメントを捨てて、超美麗なドキュメント作成をasciidoctorで実現しよう！![[支える技術]エクセルやパワーポイントのドキュメントを捨てて、超美麗なドキュメント作成をasciidoctorで実現しよう！](https://cdn-ak-scissors.b.st-hatena.com/image/square/e45f65486901307445fa766ae58c9833f354eda9/height=288;version=1;width=512/https%3A%2F%2Fprice-checker.jp%2Fwp-content%2Fuploads%2F2015%2F01%2Fpicjumbo.com_HNCK4034.jpg)
Asciidoctor 文法クイックリファレンス(日本語訳)
AsciiDoc の使い方