手順書の書き方 (3 分で読める)

このサイトは Markdown というプレーンテキストで書きます。難しいことは要りません。見出し (#)、箇条書き (-)、番号付き (1.) の 3 つで十分です。

一番かんたんな書き方: ブラウザだけで

1. 直したいページの下にある「このページを GitHub で編集」を押す。
2. GitHub の画面で文章を直し、右上の「Commit changes...」→「Create a new branch」のまま「Propose changes」。
3. 「Create pull request」を押す。これで PR (変更の提案) になります。
4. 少し待つと、PR に プレビューの URL がコメントされます。開いて見た目を確認します。
5. エンジニアが確認してマージすると、本番に反映されます。

新しいページを作るときは、GitHub のリポジトリ cgslab/team-wiki の docs/ 以下で「Add file」→「Create new file」。ファイル名は英数字で <セクション>/<名前>.md (例: software/metashape.md)。中身は ひな形 をコピーしてください。

Claude に頼む

GitHub の PR に @claude 付きでコメントすると、Claude が代わりに書いたり直したりします。例: 「@claude このページを『です・ます』調にそろえて」。

書くときの約束

• 1 ページ 1 トピック。「Metashape の入れ方」と「Metashape で書き出しが失敗する」は別ページ。
• 先頭に、対象・所要時間・必要なもの を 1 行で。
• 手順は番号付き。1 つの番号に 1 つの操作。
• 症状はそのままの言葉で。検索で見つかるように、画面に出たメッセージをそのまま書く。
• 載せないもの: パスワード、ライセンスキー、カード番号、個人の連絡先。それらは 資産・アカウント管理 に入れてリンクする。

よく使う書き方

# 見出し (ページのタイトル。1 ページに 1 つ)

## 小見出し

1. 番号付きの手順
2. 次の手順

- 箇条書き
- 箇条書き

**太字**、`コマンドやファイル名`

[リンクの文字](/software/)   ← サイト内のページ
[外のサイト](https://example.com)

![画像の説明](/screenshot.png)   ← 画像は docs/public/ に置く

::: tip コツ
補足はこの枠で
:::

::: warning 注意
気をつけることはこの枠で
:::

画像

スクリーンショットは docs/public/ に置き、![説明](/ファイル名.png) で貼ります。1 枚 1 MB 以下にしてください (Windows の「切り取り & スケッチ」で撮ったものならそのままで大丈夫です)。

新しいページをメニューに出す

ページを足したら、docs/.vitepress/config.mts の sidebar にも 1 行足します。分からなければ PR の説明に「メニューに足してほしい」と書けばエンジニアがやります。