YAML で画面設計書を書いて Markdown で出力する - Qiita

タイトルの内容をこうやってみましたというレポートです。 経緯 小さめ(画面10未満)・比較的単純なWebアプリ案件の設計書を記述する必要あり 設計書のフォーマット・ファイル形式に指定はなし、ファイル出力の必要もなし 好きにやっていいとの指示 希望 Word や Excel で書きたくない テキストベースで書いて、リポジトリ管理したい ソースと配置をなるべく分けたくない ソースはGitLab リポジトリで管理 案 GitLab の Wiki に Markdown で記述する 懸念点 Markdown では、画面設計書に必要な以下の内容を記述しにくい 表形式 定まったフォーマット(記述の自由度が高い) 打開策 内容は、YAML で記述する 表形式など表示を見やすくするために、YAML を読み込んで Markdown に変換する YAML とは 人間が扱いやすい、構造化データ・オブジェクトを記述