Skip to content

OSS向けの操作マニュアル(docs/guide)を追加 - #10

Merged
uswebk merged 1 commit into
mainfrom
reference/add-user-guide
Jul 12, 2026
Merged

OSS向けの操作マニュアル(docs/guide)を追加#10
uswebk merged 1 commit into
mainfrom
reference/add-user-guide

Conversation

@uswebk

@uswebk uswebk commented Jul 12, 2026

Copy link
Copy Markdown
Owner

概要

OSS公開向けに、エンドユーザー(現場の管理者)向けの操作マニュアルを docs/guide/ に新設しました。これまでドキュメントは開発者向け(architecture / CONTRIBUTING / domain)に偏っており、「どの画面で何ができて、どう操作するか」を説明したものが1本もありませんでした。

内容

  • docs/guide/ に英日ペアで11画面分のガイドを追加
    • index / getting-started(サインアップ〜現場モニター表示までの通し手順)
    • 画面別: site-selection / home / editor / assignment / viewer / employees / members / history / settings
  • UIラベルは i18n/locales/{en,ja}.json から拾っており、画面の表記と一致します
  • 全ページにスクリーンショットを配置(docs/images/guide/)。命名規則と撮影の規約は docs/images/guide/SHOTS.md
  • README(英日)に「主な機能」節とマニュアルへの導線を追加。これまで未記載だったタグ・CSV入出力・規格のバージョン管理・ビュアー設定・一括招待・拠点別権限を明記

補足

  • ドメイン用語は再定義せず docs/domain/*.md へリンクしています
  • リポジトリ内リンク・アンカー・画像参照はスクリプトで検証済み(切れなし、英日で画像枚数一致)

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@uswebk
uswebk merged commit 71a951e into main Jul 12, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant