ドキュメントサイトの編集方法¶
概要¶
- 社内ドキュメントサイト(doc.enlight-cons.com)のマニュアルを追加・編集する方法
- エンジニア知識は不要。ブラウザだけで完結する
- 編集すると自動でサイトに反映される(1〜2分)
手順¶
マニュアルを編集する¶
ステップ1: 管理画面にアクセス¶
ブラウザで以下のURLを開く:
https://doc.enlight-cons.com/admin/
ステップ2: GitHubでログイン¶
「Login with GitHub」をクリックし、GitHubアカウントでログインする。
- 初回のみ認証の許可が求められるので「Authorize」を押す
ステップ3: マニュアル一覧から編集対象を選択¶
左メニューの「マニュアル」をクリックすると一覧が表示される。編集したいマニュアルをクリック。
ステップ4: 内容を編集¶
- タグ: クライアント名(
client/CU024_スワル株式会社等)や業務カテゴリ(経理,労務等)を入力 - 最終レビュー日: 編集した日の日付に更新する
- 本文: リッチテキストエディタで編集。見出し・太字・リスト・リンク・画像などが使える
ステップ5: 保存¶
画面上部の「Publish」ボタンを押す。1〜2分で本番サイトに反映される。
新しいマニュアルを作成する¶
ステップ1: 管理画面で「New マニュアル」をクリック¶
管理画面のマニュアル一覧ページ上部にある「New マニュアル」ボタンを押す。
ステップ2: 必要項目を入力¶
- タグ(必須): 最低1つは
client/CU***_会社名形式のタグを入力する - 最終レビュー日: 今日の日付を選択
- 本文: マニュアルの内容を記入する
ステップ3: 本文の書き方¶
以下の構成で書く:
# マニュアルタイトル
## 概要
- この手順の目的
- いつ・誰が実施するか
## 手順
### ステップ1: やること
具体的な操作を記載。
### ステップ2: やること
...
## 注意事項
- よくある間違い、気をつけるポイント
ステップ4: 画像を挿入する¶
エディタのツールバーにある画像アイコン(🖼️)をクリックし、画像ファイルを選択するとアップロードされる。
ステップ5: 保存・公開¶
「Publish」→「Publish now」を押して公開する。
マニュアルを削除する¶
管理画面で対象のマニュアルを開き、画面上部の「Delete」→確認で削除できる。
タグの命名ルール¶
| 種類 | 形式 | 例 |
|---|---|---|
| クライアント | client/CU***_会社名 |
client/CU024_スワル株式会社 |
| 業務カテゴリ | 自由 | 経理, 労務, 法務, IT |
| その他 | 自由 | 月次, 社内共通 |
- クライアントタグは必ず1つ以上つける
- 社内共通のマニュアルは
社内共通タグを使う
注意事項¶
- 編集中に他の人が同じマニュアルを編集すると競合する可能性がある。編集前にSlack等で一声かけると安全
- 「Publish」を押すまでは公開されない。下書き保存も可能(「Save」ボタン)