ドキュメント作成は何をつかう(その4)
マニュアルのひな形案です。
markdownのソース形式です。
# 【ひな形】〇〇〇マニュアル <a name="#top"></a>
発効日:yyyy年mm月dd日 所属名
[TOC]
## 概要
[【top】](#top)
## 業務フロー
1. 【依頼者】〇〇を行う。
2. 【担当者】〇〇を受けて、△△する。
※ 業務フローの書き方は **順序つきリストで【役割】することで記述を統一** する。
※ umlも記入できるが、操作を簡便にしたいので、umlのパッケージは使わない予定。
[【top】](#top)
## 注意点
- 順序無しリスト
[【top】](#top)
## 問い合わせ先
| 〇〇担当 | sample@hogehoga.co.jp |
| -------- | --------------------- |
文字列に 『@』 があるとメールアドレスとして認識され、メーラーが起動する。
[【top】](#top)
markdownの機能外の部分は
段落1に
<a name="#top"></a>
段落2の最後に
[【top】](#top)
を記述しただけ。
ルールは簡単。
1行目は、段落1とし、 マニュアルのタイトル と #top のタグ記述だけ
2行目は 発効日 と 責任所属 だけ
3行目は 目次 Typora なら、段落 → 目次 の選択
4行目から、段落2で章建てしてマニュアルを書く。段落2の最後には、段落1 にリンクできる命令を入れるだけ。
できるだけ、シンプルにしてみました。