← MarkNext の紹介へ戻る

MarkNext の詳細

紹介ページに入れると長くなる二つ、描ける図の見本体裁の設定を、 こちらにまとめました。画面と図は、すべて架空のサンプル文書のものです。

DIAGRAM SAMPLES図の見本

紹介ページで使ったサンプル文書に入っている、残りの図です。 一つの画面の仕様を状態遷移処理の流れやり取りの順序の 三通りで書き、それぞれを二つの記法で描いてあります。どれも本文に文字として書いてあり、 文書を開けばこの形で表示されます。

状態遷移(PlantUML)

紹介ページに出した mermaid・draw.io と同じ状態遷移を、PlantUML で描いたものです。 PlantUML はサーバーが描画するので、社内のサーバーを指定するか、描画を切って使います。

一覧画面のキー操作の状態遷移図を PlantUML で描いたもの
2-b. PlantUML。同じ状態遷移でも、記法が変われば絵の組み方も変わります。

処理の流れ(キー1回ぶん)

キー入力1回ぶんの処理の流れを mermaid のフローチャートで描いたもの
3-a. mermaid(フローチャート)
同じ処理の流れを PlantUML のアクティビティ図で描いたもの
3-b. PlantUML(アクティビティ図)

押下から処理完了まで(シーケンス)

保存キーを押してから完了するまでのやり取りを mermaid のシーケンス図で描いたもの
4-a. mermaid(シーケンス図)
同じやり取りを PlantUML のシーケンス図で描いたもの
4-b. PlantUML(シーケンス図)

扱える図は、状態遷移や流れだけではありません

同じ書き方で、下のような図も文書に置けます。draw.io の図だけは書き方が違い、 絵の中に編集用のデータが入っています。

技術文書の作業を枝分かれで整理したマインドマップ
マインドマップ(mermaid)。章立てを決める前の下書きに使います。
曜日と時間帯ごとの受注件数をヒートマップにしたもの
ヒートマップ(Vega-Lite)。集計結果を JSON で貼ると図になります。 数字の表では気づけない偏り——金曜の昼過ぎに集中している——が見えます。
通信の電文の並びを桁で示したパケット図
パケット図(mermaid)。通信の電文や、固定長レコードの並びを桁で示します。
納品書の様式を、欄の位置と桁数まで再現した図
自由配置の図(draw.io)。帳票の様式は、どの欄がどこにあるかが仕様そのものなので、 自動配置では書き表せません。文書には .drawio.svg 一枚として置かれ、 右クリックでいつでも開き直せます。

バーコードと QR コード、タイミング図とビット配置は、それぞれ別のページにまとめてあります。 バーコードと QR コードの記法 タイミング図とビット配置の記法

図はどれも文書の一部です。書き換えれば描き直され、 PDF や HTML にもそのまま載ります。図は全て SVG としてエクスポートできます。 文書内の図を、節名を付けて一括で書き出せます。記法が選べるので、 渡す相手が読み慣れた書き方に合わせられます。

STYLE体裁は「スタイル」としてまとめて選ぶ

番号の付け方、章の字下げ、改ページの位置、書体。文書の体裁は項目が多く、 毎回そろえ直すと手間がかかります。MarkNext ではこれらを「スタイル」という一式にまとめ、 文書ごとに選べるようにしました。プレビューと印刷・PDF は同じ設定を読むので、 画面で見えている体裁がそのまま出力になります。

見出しの番号

ISO(1.1.1)、ピリオド付き、日本語慣用(第1章/1-1)、日本の法令、欧文アウトライン、米国法令などから選べます。文書のタイトルを一段として数えるかどうかも指定できます。

字下げ(段下げ)

見出しの深さに応じて本文を段下げできます。開始する見出しレベルと段の深さを選べ、図・表・コードを一緒に下げるかどうかも指定できます。段落の先頭行を1字下げる和文の作法にも対応します。

箇条書きの番号

(1) / ① / a. などの階層を、三段まで自分で定義できます。

改ページとページ番号

見出し1〜3 ごとに改ページできます。見出しの直後でページを切らない指定や、PDF のページ番号の形式も選べます。

書体と組み

本文と見出しの書体、文字サイズ、行間を指定できます。出力テーマに従うことも、文書側で決めることもできます。

見出しの罫

節見出しの左に罫を引くかどうかを切り替えられます。仕様書らしい体裁のための小さな設定です。

仕様書のないシステムの調査・技術文書整備について相談する

現行仕様の復元、移行前調査、運用資料の整備、閉域環境での文書制作についてご相談いただけます。

相談してみる →