はじめての方向け:Confluenceを編集・閲覧するには?
概要
Confluenceの使い方を共有するページです
ページの書き方と、必要な情報に効率的にたどり着く方法を記載します
目的
スタッフ誰もがConfluenceを編集できるようにする
Confluenceは高機能な分とっつきづらいので、これだけを押さえておけばOKというような使い方を共有する
2020のスタッフのうち、ナレッジベース作成に貢献したい有志全員が貢献できてみんな嬉しい(はず)。ナレッジベースが残るので、2021以降のスタッフも嬉しい
スタッフがConfluenceから情報を引き出せるようにする
目次
- 1 概要
- 2 目的
- 2.1 目次
- 3 スケジュール
- 4 Confluence編集方法(気をつける点)
- 4.1 編集するページへの移動方法は以下の2通り
- 4.2 編集
- 4.3 編集したあとは
- 4.4 わからないことがあったら
- 5 オススメのマクロ
- 6 Confluence上の必要な情報にたどりつく方法
- 7 チェックリスト
- 8 各タスクの詳細
スケジュール
会期後(2020年9月後半)から有志でナレッジベース作成を開始
いつまでにどの程度まとめるかはこれから決める
(ここに大まかなスケジュールを箇条書きで書いてください。具体的な例も入れよう)
Confluence編集方法(気をつける点)
編集するページへの移動方法は以下の2通り
サイトビュー(左側の目次)にある既存のページを編集する
まだない事項について、ページを新規作成して記載する
既存のページの編集
まずはサイドバーから書けそうなページを選ぶ
新規作成のときは、テンプレートから作成する
記載事項を揃えるためにテンプレートから作成してください
(テンプレートにない事項を書いてもいいですが、テンプレートの事項は必ず網羅して下さい)
上部の作成から新規ページを作成できる
作成するときに「タイトル(タスク名)」というテンプレートを選ぶ
→新規ページが作成される
編集
鉛筆アイコンをクリックすると、ページを編集できるモードになります
書き方については Sandbox ページで練習するのをオススメします
テンプレートに沿って上から書いていって下さい
TIPS(随時追加)
Confluence内のURLはそのままペーストするのがよさそうです(タイトルが埋め込まれる)
タイトルが変更されたとき、自動で更新されるため
テキストを選択し、[Ctrl]+[K]でリンクにできますが、タイトルを変更したあとテキストの編集が発生します
編集したあとは
右上の部分の操作方法について
「閉じる」→変更は保存されるが、ページの内容は変わらない(非公開の変更。編集モードにならない限り他のスタッフからは見えない)
「公開」→変更が保存され、ページも変わる(ページに移動したら最新の内容が見える)
共有について(現在分かっていること)
共有しなくてもPyCon JPスタッフは全ページ見られます
PyCon JPスタッフの名前(またはメールアドレス)を指定して共有すると、その人に通知が飛ぶようです(確認して下さいというときに使うとよさそう)
PyCon JPスタッフ以外の人のメールアドレスも入力できます
Atlassianアカウントがない場合は作成が案内されます(Confluence, JIRAなどはAtlassian社の製品です)
Atlassianアカウントを持っていたらPyCon JPナレッジベースのConfluenceが全て見られるようになるようです(いずれ一般公開するので作成中はスタッフ以外には共有しないのがよさそう)
わからないことがあったら
質問は以下のどちらかでお願いします
このページにコメントする。 @Takuya Futatsugi [nikkie にっきー] (Unlicensed) に知らせてください
Slackの #2020 にて
@nikkie
メンションで知らせるまでお願いします
質問の内容に応じて追記していきます
オススメのマクロ
Confluence上の必要な情報にたどりつく方法
検索ボックスに知りたいキーワードを入力して、必要とする情報が含まれるページを探します。
検索の付随機能を活用することで、より的確に情報のたどり着くことができます。
スペースには「PyCon JP」を指定することをオススメします。
将来的にはラベルなどの活用も良さそうです
ページツリーから辿ることも可能ですが、検索機能の使用が便利です。
情報の構造は単純な1次元1方向のツリーでは表現しきれないため。
ページを作成・編集する際には、そのページに含まれる情報を必要とするユーザーが検索でたどり着きやすいように、ページの記述方法を工夫・意識することも重要です。
以下はあとで書きます
コピー&異動した後、まずチェックリストまでを埋めて下さい🙏
チェックリスト
(ここにはタスクを実施する上で確認すべき項目を列挙する。実際には各スケジュールに紐付いて実施される想定)
[いつ] 〇〇する
以下は優先度が低いです。他のページを先に埋めてもらって大丈夫です
各タスクの詳細
スケジュールに書いた各項目でどういったことを実施するかを書いてください。誰と連携するのかも書いてあるとよいです
(項目の名前)
(ここに項目ごとになにをやるのかを詳細に書く)
(項目の名前)
(ここに項目ごとになにをやるのかを詳細に書く)